diff --git a/openapi.yml b/openapi.yml index e81f789..05ef854 100644 --- a/openapi.yml +++ b/openapi.yml @@ -375,6 +375,12 @@ paths: application/json: schema: $ref: "#/components/schemas/ApiResponse" + '400': + description: Bad request, see error message for details + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" /collections/{collectionName}/documents/search: get: tags: @@ -434,6 +440,12 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchOverridesResponse" + '404': + description: List of search overrides not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" /collections/{collectionName}/overrides/{overrideId}: get: tags: @@ -462,6 +474,12 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchOverride" + '404': + description: Search override not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" put: tags: - documents @@ -792,7 +810,7 @@ paths: get: tags: - documents - summary: Retreive a document + summary: Retrieve a document description: Fetch an individual document from a collection by using its ID. operationId: getDocument parameters: @@ -963,6 +981,12 @@ paths: schema: $ref: '#/components/schemas/ConversationModelSchema' description: A conversation model + '404': + description: Model not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" summary: Retrieve a conversation model tags: - conversations @@ -989,6 +1013,12 @@ paths: schema: $ref: '#/components/schemas/ConversationModelSchema' description: The conversation model was successfully updated + '404': + description: Model not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" summary: Update a conversation model tags: - conversations @@ -1009,6 +1039,12 @@ paths: schema: $ref: '#/components/schemas/ConversationModelSchema' description: The conversation model was successfully deleted + '404': + description: Model not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" summary: Delete a conversation model tags: - conversations @@ -1392,6 +1428,12 @@ paths: application/json: schema: $ref: "#/components/schemas/ApiResponse" + '404': + description: Collection or field missing + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" get: tags: - analytics @@ -3575,4 +3617,4 @@ components: api_key_header: type: apiKey name: X-TYPESENSE-API-KEY - in: header + in: header \ No newline at end of file