Skip to content

Commit

Permalink
Regenerated API specs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sauterl
sauterl committed Jan 19, 2024
1 parent 1a695ae commit 64252e9
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 66 deletions.
74 changes: 41 additions & 33 deletions doc/oas-client.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -452,12 +452,22 @@
"security" : [ ]
}
},
"/api/v2/log/query" : {
"/api/v2/log/query/{evaluationId}" : {
"post" : {
"tags" : [ "Log" ],
"summary" : "Accepts query logs from participants",
"operationId" : "postApiV2LogQuery",
"summary" : "Accepts query logs from participants for the specified evaluation.",
"operationId" : "postApiV2LogQueryByEvaluationId",
"parameters" : [ {
"name" : "evaluationId",
"in" : "path",
"description" : "The evaluation ID.",
"required" : true,
"deprecated" : false,
"allowEmptyValue" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "session",
"in" : "query",
"description" : "Session Token",
Expand Down Expand Up @@ -514,12 +524,22 @@
"security" : [ ]
}
},
"/api/v2/log/result" : {
"/api/v2/log/result/{evaluationId}" : {
"post" : {
"tags" : [ "Log" ],
"summary" : "Accepts result logs from participants.",
"operationId" : "postApiV2LogResult",
"summary" : "Accepts result logs from participants for the specified evaluation.",
"operationId" : "postApiV2LogResultByEvaluationId",
"parameters" : [ {
"name" : "evaluationId",
"in" : "path",
"description" : "The evaluation ID.",
"required" : true,
"deprecated" : false,
"allowEmptyValue" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "session",
"in" : "query",
"description" : "Session Token",
Expand Down Expand Up @@ -2467,32 +2487,6 @@
},
"required" : [ "timestamp", "events" ]
},
"QueryResult" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"item" : {
"type" : "string"
},
"segment" : {
"type" : "integer",
"format" : "int32"
},
"frame" : {
"type" : "integer",
"format" : "int32"
},
"score" : {
"type" : "number",
"format" : "double"
},
"rank" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "item" ]
},
"QueryResultLog" : {
"type" : "object",
"additionalProperties" : false,
Expand All @@ -2510,7 +2504,7 @@
"results" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/QueryResult"
"$ref" : "#/components/schemas/RankedAnswer"
}
},
"events" : {
Expand All @@ -2522,6 +2516,20 @@
},
"required" : [ "timestamp", "sortType", "resultSetAvailability", "results", "events" ]
},
"RankedAnswer" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"answer" : {
"$ref" : "#/components/schemas/ApiClientAnswer"
},
"rank" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "answer" ]
},
"TemporalPoint" : {
"type" : "object",
"additionalProperties" : false,
Expand Down
74 changes: 41 additions & 33 deletions doc/oas.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3348,12 +3348,22 @@
"security" : [ ]
}
},
"/api/v2/log/query" : {
"/api/v2/log/query/{evaluationId}" : {
"post" : {
"tags" : [ "Log" ],
"summary" : "Accepts query logs from participants",
"operationId" : "postApiV2LogQuery",
"summary" : "Accepts query logs from participants for the specified evaluation.",
"operationId" : "postApiV2LogQueryByEvaluationId",
"parameters" : [ {
"name" : "evaluationId",
"in" : "path",
"description" : "The evaluation ID.",
"required" : true,
"deprecated" : false,
"allowEmptyValue" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "session",
"in" : "query",
"description" : "Session Token",
Expand Down Expand Up @@ -3410,12 +3420,22 @@
"security" : [ ]
}
},
"/api/v2/log/result" : {
"/api/v2/log/result/{evaluationId}" : {
"post" : {
"tags" : [ "Log" ],
"summary" : "Accepts result logs from participants.",
"operationId" : "postApiV2LogResult",
"summary" : "Accepts result logs from participants for the specified evaluation.",
"operationId" : "postApiV2LogResultByEvaluationId",
"parameters" : [ {
"name" : "evaluationId",
"in" : "path",
"description" : "The evaluation ID.",
"required" : true,
"deprecated" : false,
"allowEmptyValue" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "session",
"in" : "query",
"description" : "Session Token",
Expand Down Expand Up @@ -6881,32 +6901,6 @@
},
"required" : [ "timestamp", "events" ]
},
"QueryResult" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"item" : {
"type" : "string"
},
"segment" : {
"type" : "integer",
"format" : "int32"
},
"frame" : {
"type" : "integer",
"format" : "int32"
},
"score" : {
"type" : "number",
"format" : "double"
},
"rank" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "item" ]
},
"QueryResultLog" : {
"type" : "object",
"additionalProperties" : false,
Expand All @@ -6924,7 +6918,7 @@
"results" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/QueryResult"
"$ref" : "#/components/schemas/RankedAnswer"
}
},
"events" : {
Expand All @@ -6936,6 +6930,20 @@
},
"required" : [ "timestamp", "sortType", "resultSetAvailability", "results", "events" ]
},
"RankedAnswer" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"answer" : {
"$ref" : "#/components/schemas/ApiClientAnswer"
},
"rank" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "answer" ]
},
"TemporalPoint" : {
"type" : "object",
"additionalProperties" : false,
Expand Down

0 comments on commit 64252e9

Please sign in to comment.