Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 4XX descriptions for the following resources #84

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add 4XX descriptions for the following resources #84

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b3317f
Add 404 description to get and delete conversation model
jaeyson Dec 10, 2024
f6d8c3c
Add 404 to retrieve a single search override
jaeyson Dec 10, 2024
3476a56
add 404 for list of search overrides
jaeyson Dec 10, 2024
374d6b6
add 400 bad request to delete multiple documents
jaeyson Dec 11, 2024
a6a2df0
fix typo
jaeyson Dec 11, 2024
4e03e6c
add 404 to updating a conversation model
jaeyson Dec 11, 2024
890e836
add 404 when creating analytics rule
jaeyson Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -3575,4 +3617,4 @@ components:
api_key_header:
type: apiKey
name: X-TYPESENSE-API-KEY
in: header
in: header