diff --git a/docs/openapi.md b/docs/openapi.md index 07677950..f44141ca 100644 --- a/docs/openapi.md +++ b/docs/openapi.md @@ -165,11 +165,13 @@ Returns: | Status Code | Description | Component | |-------------|-------------|-----------| -| 200 | Successful Response | [FeedbackResponse](#feedbackresponse) +| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse) | -| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) +| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) | -| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) +| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse) + | +| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse) | | 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | @@ -606,6 +608,17 @@ Database configuration. | postgres | | | +## ErrorResponse + + +Model representing error response for query endpoint. + + +| Field | Type | Description | +|-------|------|-------------| +| detail | object | | + + ## FeedbackCategory @@ -661,7 +674,7 @@ Examples: | llm_response | string | Response from LLM | | sentiment | | User sentiment, if provided must be -1 or 1 | | user_feedback | | Feedback on the LLM response. | -| categories | array[FeedbackCategory] | List of feedback categories that describe issues with the LLM response (for negative feedback). | +| categories | | List of feedback categories that describe issues with the LLM response (for negative feedback). | ## FeedbackResponse diff --git a/docs/output.md b/docs/output.md index 20f4e99c..7fe5ee76 100644 --- a/docs/output.md +++ b/docs/output.md @@ -165,11 +165,13 @@ Returns: | Status Code | Description | Component | |-------------|-------------|-----------| -| 200 | Successful Response | [FeedbackResponse](#feedbackresponse) +| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse) | -| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) +| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) | -| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) +| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse) + | +| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse) | | 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | @@ -606,6 +608,17 @@ Database configuration. | postgres | | | +## ErrorResponse + + +Model representing error response for query endpoint. + + +| Field | Type | Description | +|-------|------|-------------| +| detail | object | | + + ## FeedbackCategory