Merge pull request #537 from tisnik/lcore-390-field-description-for-readiness-response

LCORE-390: field description for ReadinessResponse model

Author: tisnik

docs/openapi.json

@@ -2240,18 +2240,29 @@
                 "properties": {
                     "ready": {
                         "type": "boolean",
-                        "title": "Ready"
+                        "title": "Ready",
+                        "description": "Flag indicating if service is ready",
+                        "examples": [
+                            true,
+                            false
+                        ]
                     },
                     "reason": {
                         "type": "string",
-                        "title": "Reason"
+                        "title": "Reason",
+                        "description": "The reason for the readiness",
+                        "examples": [
+                            "Service is ready"
+                        ]
                     },
                     "providers": {
                         "items": {
                             "$ref": "#/components/schemas/ProviderHealthStatus"
                         },
                         "type": "array",
-                        "title": "Providers"
+                        "title": "Providers",
+                        "description": "List of unhealthy providers in case of readiness failure.",
+                        "examples": []
                     }
                 },
                 "type": "object",

docs/openapi.md

@@ -754,7 +754,7 @@ Examples:
     feedback_request = FeedbackRequest(
         conversation_id="12345678-abcd-0000-0123-456789abcdef",
         user_question="what are you doing?",
-        user_feedback="Great service!",
+        user_feedback="This response is not helpful",
         llm_response="I don't know",
         sentiment=1
     )
@@ -1124,9 +1124,9 @@ Example:
 
 | Field | Type | Description |
 |-------|------|-------------|
-| ready | boolean |  |
-| reason | string |  |
-| providers | array |  |
+| ready | boolean | Flag indicating if service is ready |
+| reason | string | The reason for the readiness |
+| providers | array | List of unhealthy providers in case of readiness failure. |
 
 
 ## SQLiteDatabaseConfiguration

docs/output.md

@@ -1114,9 +1114,9 @@ Example:
 
 | Field | Type | Description |
 |-------|------|-------------|
-| ready | boolean |  |
-| reason | string |  |
-| providers | array |  |
+| ready | boolean | Flag indicating if service is ready |
+| reason | string | The reason for the readiness |
+| providers | array | List of unhealthy providers in case of readiness failure. |
 
 
 ## SQLiteDatabaseConfiguration

src/models/responses.py

@@ -173,9 +173,23 @@ class ReadinessResponse(BaseModel):
         ```
     """
 
-    ready: bool
-    reason: str
-    providers: list[ProviderHealthStatus]
+    ready: bool = Field(
+        ...,
+        description="Flag indicating if service is ready",
+        examples=[True, False],
+    )
+
+    reason: str = Field(
+        ...,
+        description="The reason for the readiness",
+        examples=["Service is ready"],
+    )
+
+    providers: list[ProviderHealthStatus] = Field(
+        ...,
+        description="List of unhealthy providers in case of readiness failure.",
+        examples=[],
+    )
 
     # provides examples for /docs endpoint
     model_config = {