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

Update/fix error response codes in API spec #17

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Update/fix error response codes in API spec #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
118 changes: 112 additions & 6 deletions src/main/resources/META-INF/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,14 @@ paths:
nullable: false
items:
$ref: '#/components/schemas/Assistant'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
post:
# TODO: POST is typically for create, where PUT or PATCH are for update... why are these concepts grouped?
operationId: create-or-update-assistant
Expand Down Expand Up @@ -79,10 +83,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
/admin/assistant/{assistantObjectIdHexString}:
parameters:
- name: assistantObjectIdHexString
Expand All @@ -103,10 +111,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
delete:
operationId: delete-assistant
summary: Delete Assistant
Expand All @@ -115,6 +127,14 @@ paths:
responses:
'200':
$ref: '#/components/responses/CommonDeleteResponse'
'400':
$ref: '#/components/responses/CommonDeleteResponse'
'401':
$ref: '#/components/responses/CommonDeleteResponse'
'403':
$ref: '#/components/responses/CommonDeleteResponse'
'500':
$ref: '#/components/responses/CommonDeleteResponse'

/admin/assistant/llm:
get:
Expand All @@ -132,10 +152,14 @@ paths:
nullable: false
items:
$ref: '#/components/schemas/LLMConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
post:
# TODO: POST is typically for create, where PUT or PATCH are for update... why are these concepts grouped?
operationId: create-or-update-llm-connection
Expand Down Expand Up @@ -171,10 +195,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/LLMConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
/admin/assistant/llm/{llmConnectionObjectIdHexString}:
parameters:
- name: llmConnectionObjectIdHexString
Expand All @@ -195,10 +223,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/LLMConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
delete:
operationId: delete-llm-connection
summary: Delete LLM Connection
Expand All @@ -207,6 +239,14 @@ paths:
responses:
'200':
$ref: '#/components/responses/CommonDeleteResponse'
'400':
$ref: '#/components/responses/CommonDeleteResponse'
'401':
$ref: '#/components/responses/CommonDeleteResponse'
'403':
$ref: '#/components/responses/CommonDeleteResponse'
'500':
$ref: '#/components/responses/CommonDeleteResponse'

/admin/assistant/retrieverConnection:
get:
Expand All @@ -224,10 +264,14 @@ paths:
nullable: false
items:
$ref: '#/components/schemas/RetrieverConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
post:
operationId: create-or-update-retriever-connection
summary: Create/Update Retriever Connection
Expand Down Expand Up @@ -258,10 +302,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RetrieverConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
/admin/assistant/retrieverConnection/{retrieverConnectionObjectIdHexString}:
parameters:
- name: retrieverConnectionObjectIdHexString
Expand All @@ -282,10 +330,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RetrieverConnection'
'400':
$ref: '#/components/responses/Common400Response'
'401':
$ref: '#/components/responses/Common401Response'
'403':
$ref: '#/components/responses/Common403Response'
'500':
$ref: '#/components/responses/Common500Response'
delete:
operationId: delete-retriever-connection
summary: Delete Retriever Connection
Expand All @@ -294,6 +346,14 @@ paths:
responses:
'200':
$ref: '#/components/responses/CommonDeleteResponse'
'400':
$ref: '#/components/responses/CommonDeleteResponse'
'401':
$ref: '#/components/responses/CommonDeleteResponse'
'403':
$ref: '#/components/responses/CommonDeleteResponse'
'500':
$ref: '#/components/responses/CommonDeleteResponse'

/assistant/chat/streamingWithFileUpload:
post:
Expand Down Expand Up @@ -343,10 +403,14 @@ paths:
type: array
items:
type: string
'400':
$ref: '#/components/responses/PlainText400Response'
'401':
$ref: '#/components/responses/Common401Response'
$ref: '#/components/responses/PlainText401Response'
'403':
$ref: '#/components/responses/Common403Response'
$ref: '#/components/responses/PlainText403Response'
'500':
$ref: '#/components/responses/PlainText500Response'

/assistant/chat/streaming:
post:
Expand All @@ -370,10 +434,14 @@ paths:
type: array
items:
type: string
'400':
$ref: '#/components/responses/PlainText400Response'
'401':
$ref: '#/components/responses/Common401Response'
$ref: '#/components/responses/PlainText401Response'
'403':
$ref: '#/components/responses/Common403Response'
$ref: '#/components/responses/PlainText403Response'
'500':
$ref: '#/components/responses/PlainText500Response'

components:
schemas:
Expand Down Expand Up @@ -562,20 +630,58 @@ components:
# TODO: Define common error response structure
additionalProperties: true
responses:
Common400Response:
description: Bad Request, with error details (ie, request validation failures) as JSON object.
content:
application/json:
schema:
# TODO: Create a validation failure type
$ref: '#/components/schemas/CommonError'
Common401Response:
description: Not Authorized
description: Not Authorized, with error details as a JSON object
content:
application/json:
schema:
$ref: '#/components/schemas/CommonError'
Common403Response:
description: Not Allowed
description: Not Allowed, with error details as a JSON object
content:
application/json:
schema:
$ref: '#/components/schemas/CommonError'
Common500Response:
description: Server Error, with details as a JSON object
content:
application/json:
schema:
$ref: '#/components/schemas/CommonError'
PlainText400Response:
description: Bad Request, with error details in plain text
content:
text/plain:
schema:
type: string
PlainText401Response:
description: Not Authorized, with error details in plain text
content:
text/plain:
schema:
type: string
PlainText403Response:
description: Not Allowed, with error details in plain text
content:
text/plain:
schema:
type: string
PlainText500Response:
description: Server Error, with error details in plain text
content:
text/plain:
schema:
type: string
CommonDeleteResponse:
description: Empty response, since DELETE method disallows content body
# Note: A lack of the `content` property here indicates that there is no response body.
securitySchemes:
OIDC:
type: openIdConnect
Expand Down
Loading