Skip to content

Commit a54a54b

Browse files
committed
Updated OpenAPI doc
1 parent ecd1609 commit a54a54b

File tree

2 files changed

+33
-7
lines changed

2 files changed

+33
-7
lines changed

docs/openapi.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,13 @@ Returns:
165165

166166
| Status Code | Description | Component |
167167
|-------------|-------------|-----------|
168-
| 200 | Successful Response | [FeedbackResponse](#feedbackresponse)
168+
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse)
169169
|
170-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
170+
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
171171
|
172-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
172+
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse)
173+
|
174+
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse)
173175
|
174176
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
175177
|
@@ -606,6 +608,17 @@ Database configuration.
606608
| postgres | | |
607609

608610

611+
## ErrorResponse
612+
613+
614+
Model representing error response for query endpoint.
615+
616+
617+
| Field | Type | Description |
618+
|-------|------|-------------|
619+
| detail | object | |
620+
621+
609622
## FeedbackCategory
610623

611624

@@ -661,7 +674,7 @@ Examples:
661674
| llm_response | string | Response from LLM |
662675
| sentiment | | User sentiment, if provided must be -1 or 1 |
663676
| user_feedback | | Feedback on the LLM response. |
664-
| categories | array[FeedbackCategory] | List of feedback categories that describe issues with the LLM response (for negative feedback). |
677+
| categories | | List of feedback categories that describe issues with the LLM response (for negative feedback). |
665678

666679

667680
## FeedbackResponse

docs/output.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,13 @@ Returns:
165165

166166
| Status Code | Description | Component |
167167
|-------------|-------------|-----------|
168-
| 200 | Successful Response | [FeedbackResponse](#feedbackresponse)
168+
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse)
169169
|
170-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
170+
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
171171
|
172-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
172+
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse)
173+
|
174+
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse)
173175
|
174176
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
175177
|
@@ -606,6 +608,17 @@ Database configuration.
606608
| postgres | | |
607609

608610

611+
## ErrorResponse
612+
613+
614+
Model representing error response for query endpoint.
615+
616+
617+
| Field | Type | Description |
618+
|-------|------|-------------|
619+
| detail | object | |
620+
621+
609622
## FeedbackCategory
610623

611624

0 commit comments

Comments
 (0)