From 8b3317ffb722d757517dd26c1918e299c780999b Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 06:41:21 +0800 Subject: [PATCH 1/7] Add 404 description to get and delete conversation model --- openapi.yml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/openapi.yml b/openapi.yml index e81f789..1a24466 100644 --- a/openapi.yml +++ b/openapi.yml @@ -963,6 +963,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 @@ -1009,6 +1015,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 @@ -3575,4 +3587,4 @@ components: api_key_header: type: apiKey name: X-TYPESENSE-API-KEY - in: header + in: header \ No newline at end of file From f6d8c3c6469ce22d5649a904b19a01b2141e34e4 Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 06:58:52 +0800 Subject: [PATCH 2/7] Add 404 to retrieve a single search override --- openapi.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/openapi.yml b/openapi.yml index 1a24466..ac50615 100644 --- a/openapi.yml +++ b/openapi.yml @@ -462,6 +462,12 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchOverride" + '404': + description: Search override was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ApiResponse" put: tags: - documents From 3476a56accf50228f39eb08696b1db870848f0d3 Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 07:52:56 +0800 Subject: [PATCH 3/7] add 404 for list of search overrides --- openapi.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/openapi.yml b/openapi.yml index ac50615..dc82eb6 100644 --- a/openapi.yml +++ b/openapi.yml @@ -434,6 +434,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: @@ -463,7 +469,7 @@ paths: schema: $ref: "#/components/schemas/SearchOverride" '404': - description: Search override was not found + description: Search override not found content: application/json: schema: From 374d6b67e21385b51edd5c025c6ea7c5ee4c1554 Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 14:15:12 +0800 Subject: [PATCH 4/7] add 400 bad request to delete multiple documents --- openapi.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/openapi.yml b/openapi.yml index dc82eb6..52c4108 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: From a6a2df05d494a08d627a9ef828bbf59baaacb148 Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 17:16:36 +0800 Subject: [PATCH 5/7] fix typo --- openapi.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yml b/openapi.yml index 52c4108..bed4103 100644 --- a/openapi.yml +++ b/openapi.yml @@ -810,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: From 4e03e6cee68815b29c34f0983919a6c8a8cab92d Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Wed, 11 Dec 2024 19:15:58 +0800 Subject: [PATCH 6/7] add 404 to updating a conversation model --- openapi.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/openapi.yml b/openapi.yml index bed4103..b4b1e3b 100644 --- a/openapi.yml +++ b/openapi.yml @@ -1013,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 From 890e836485fad153874141011189b754990c358b Mon Sep 17 00:00:00 2001 From: "Jaeyson Anthony Y." Date: Thu, 12 Dec 2024 18:46:58 +0800 Subject: [PATCH 7/7] add 404 when creating analytics rule --- openapi.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/openapi.yml b/openapi.yml index b4b1e3b..05ef854 100644 --- a/openapi.yml +++ b/openapi.yml @@ -1428,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