Merge pull request #468 from tisnik/update-openapi-docs

Update OpenAPI docs

Author: tisnik

docs/openapi.json

@@ -392,7 +392,7 @@
                     "feedback"
                 ],
                 "summary": "Update Feedback Status",
-                "description": "Handle feedback status update requests.\n\nTakes a request with the desired state of the feedback status.\nReturns the updated state of the feedback status based on the request's value.\nThese changes are for the life of the service and are on a per-worker basis.\n\nReturns:\n    StatusResponse: Indicates whether feedback is enabled.",
+                "description": "Handle feedback status update requests.\n\nTakes a request with the desired state of the feedback status.\nReturns the updated state of the feedback status based on the request's value.\nThese changes are for the life of the service and are on a per-worker basis.\n\nReturns:\n    FeedbackStatusUpdateResponse: Indicates whether feedback is enabled.",
                 "operationId": "update_feedback_status_v1_feedback_status_put",
                 "requestBody": {
                     "content": {

docs/openapi.md

@@ -26,8 +26,7 @@ Handle request to the / endpoint.
 
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
-| 200 | Successful Response | string
- |
+| 200 | Successful Response | string |
 ## GET `/v1/info`
 
 > **Info Endpoint Handler**
@@ -48,8 +47,7 @@ Returns:
 
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
-| 200 | Successful Response | [InfoResponse](#inforesponse)
- |
+| 200 | Successful Response | [InfoResponse](#inforesponse) |
 ## GET `/v1/models`
 
 > **Models Endpoint Handler**
@@ -76,7 +74,6 @@ Returns:
 |-------------|-------------|-----------|
 | 200 | Successful Response | [ModelsResponse](#modelsresponse) |
 | 503 | Connection to Llama Stack is broken |  |
-
 ## POST `/v1/query`
 
 > **Query Endpoint Handler**
@@ -229,6 +226,33 @@ Returns:
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
 | 200 | Successful Response | [StatusResponse](#statusresponse) |
+## PUT `/v1/feedback/status`
+
+> **Update Feedback Status**
+
+Handle feedback status update requests.
+
+Takes a request with the desired state of the feedback status.
+Returns the updated state of the feedback status based on the request's value.
+These changes are for the life of the service and are on a per-worker basis.
+
+Returns:
+    FeedbackStatusUpdateResponse: Indicates whether feedback is enabled.
+
+
+
+
+
+### 📦 Request Body 
+
+[FeedbackStatusUpdateRequest](#feedbackstatusupdaterequest)
+
+### ✅ Responses
+
+| Status Code | Description | Component |
+|-------------|-------------|-----------|
+| 200 | Successful Response | [FeedbackStatusUpdateResponse](#feedbackstatusupdateresponse) |
+| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
 ## GET `/v1/conversations`
 
 > **Get Conversations List Endpoint Handler**
@@ -396,8 +420,7 @@ Prometheus format.
 
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
-| 200 | Successful Response | string
- |
+| 200 | Successful Response | string |
 ---
 
 # 📋 Components
@@ -427,17 +450,17 @@ Available actions in the system.
 ## Attachment
 
 
-Model representing an attachment that can be send from UI as part of query.
+Model representing an attachment that can be send from the UI as part of query.
 
-List of attachments can be optional part of 'query' request.
+A list of attachments can be an optional part of 'query' request.
 
 Attributes:
     attachment_type: The attachment type, like "log", "configuration" etc.
     content_type: The content type as defined in MIME standard
     content: The actual attachment content
 
 YAML attachments with **kind** and **metadata/name** attributes will
-be handled as resources with specified name:
+be handled as resources with the specified name:
 ```
 kind: Pod
 metadata:
@@ -774,6 +797,52 @@ Example:
 | response | string |  |
 
 
+## FeedbackStatusUpdateRequest
+
+
+Model representing a feedback status update request.
+
+Attributes:
+    status: Value of the desired feedback enabled state.
+
+Example:
+    ```python
+    feedback_request = FeedbackRequest(
+        status=false
+    )
+    ```
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| status | boolean | Desired state of feedback enablement, must be False or True |
+
+
+## FeedbackStatusUpdateResponse
+
+
+Model representing a response to a feedback status update request.
+
+Attributes:
+    status: The previous and current status of the service and who updated it.
+
+Example:
+    ```python
+    status_response = StatusResponse(
+        status={
+            "previous_status": true,
+            "updated_status": false,
+            "updated_by": "user/test"
+        },
+    )
+    ```
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| status | object |  |
+
+
 ## ForbiddenResponse
 
 

docs/output.md

@@ -226,6 +226,33 @@ Returns:
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
 | 200 | Successful Response | [StatusResponse](#statusresponse) |
+## PUT `/v1/feedback/status`
+
+> **Update Feedback Status**
+
+Handle feedback status update requests.
+
+Takes a request with the desired state of the feedback status.
+Returns the updated state of the feedback status based on the request's value.
+These changes are for the life of the service and are on a per-worker basis.
+
+Returns:
+    FeedbackStatusUpdateResponse: Indicates whether feedback is enabled.
+
+
+
+
+
+### 📦 Request Body 
+
+[FeedbackStatusUpdateRequest](#feedbackstatusupdaterequest)
+
+### ✅ Responses
+
+| Status Code | Description | Component |
+|-------------|-------------|-----------|
+| 200 | Successful Response | [FeedbackStatusUpdateResponse](#feedbackstatusupdateresponse) |
+| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
 ## GET `/v1/conversations`
 
 > **Get Conversations List Endpoint Handler**
@@ -760,6 +787,52 @@ Example:
 | response | string |  |
 
 
+## FeedbackStatusUpdateRequest
+
+
+Model representing a feedback status update request.
+
+Attributes:
+    status: Value of the desired feedback enabled state.
+
+Example:
+    ```python
+    feedback_request = FeedbackRequest(
+        status=false
+    )
+    ```
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| status | boolean | Desired state of feedback enablement, must be False or True |
+
+
+## FeedbackStatusUpdateResponse
+
+
+Model representing a response to a feedback status update request.
+
+Attributes:
+    status: The previous and current status of the service and who updated it.
+
+Example:
+    ```python
+    status_response = StatusResponse(
+        status={
+            "previous_status": true,
+            "updated_status": false,
+            "updated_by": "user/test"
+        },
+    )
+    ```
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| status | object |  |
+
+
 ## ForbiddenResponse
 
 

src/app/endpoints/feedback.py

@@ -193,7 +193,7 @@ async def update_feedback_status(
     These changes are for the life of the service and are on a per-worker basis.
 
     Returns:
-        StatusResponse: Indicates whether feedback is enabled.
+        FeedbackStatusUpdateResponse: Indicates whether feedback is enabled.
     """
     user_id, _, _ = auth
     requested_status = feedback_update_request.get_value()