diff --git a/doc/oas-client.json b/doc/oas-client.json index 981fff50..52d029b8 100644 --- a/doc/oas-client.json +++ b/doc/oas-client.json @@ -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", @@ -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", @@ -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, @@ -2510,7 +2504,7 @@ "results" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/QueryResult" + "$ref" : "#/components/schemas/RankedAnswer" } }, "events" : { @@ -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, diff --git a/doc/oas.json b/doc/oas.json index 33bf21e6..05e3dd3f 100644 --- a/doc/oas.json +++ b/doc/oas.json @@ -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", @@ -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", @@ -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, @@ -6924,7 +6918,7 @@ "results" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/QueryResult" + "$ref" : "#/components/schemas/RankedAnswer" } }, "events" : { @@ -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,