From 33bd4cbb042c63abf94016f71121a0ade9ab45a3 Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Tue, 16 Sep 2025 09:25:03 +0200 Subject: [PATCH 1/2] LCORE-390: Field description for liveness response model --- src/models/responses.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/models/responses.py b/src/models/responses.py index 29b5e5776..6684a0d34 100644 --- a/src/models/responses.py +++ b/src/models/responses.py @@ -217,7 +217,11 @@ class LivenessResponse(BaseModel): ``` """ - alive: bool + alive: bool = Field( + ..., + description="Flag indicating that the app is alive", + examples=[True, False], + ) # provides examples for /docs endpoint model_config = { From abd781da799f8ea4d8a7d9a724a3453246258bfe Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Tue, 16 Sep 2025 09:25:16 +0200 Subject: [PATCH 2/2] Updated OpenAPI schema --- docs/openapi.json | 7 ++++++- docs/openapi.md | 19 ++++++++++++++++--- docs/output.md | 16 +++++++++++++++- 3 files changed, 37 insertions(+), 5 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index 96b4725c8..19b245da1 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -1821,7 +1821,12 @@ "properties": { "alive": { "type": "boolean", - "title": "Alive" + "title": "Alive", + "description": "Flag indicating that the app is alive", + "examples": [ + true, + false + ] } }, "type": "object", diff --git a/docs/openapi.md b/docs/openapi.md index 1f57223ee..08157a4f5 100644 --- a/docs/openapi.md +++ b/docs/openapi.md @@ -687,6 +687,18 @@ Example: | conversations | array | | +## CustomProfile + + +Custom profile customization for prompts and validation. + + +| Field | Type | Description | +|-------|------|-------------| +| path | string | | +| prompts | object | | + + ## Customization @@ -695,9 +707,11 @@ Service customization. | Field | Type | Description | |-------|------|-------------| +| profile_path | | | | disable_query_system_prompt | boolean | | | system_prompt_path | | | | system_prompt | | | +| custom_profile | | | ## DatabaseConfiguration @@ -748,9 +762,8 @@ Attributes: user_feedback: The optional user feedback. categories: The optional list of feedback categories (multi-select for negative feedback). -Examples: +Example: ```python - # Basic feedback feedback_request = FeedbackRequest( conversation_id="12345678-abcd-0000-0123-456789abcdef", user_question="what are you doing?", @@ -970,7 +983,7 @@ Example: | Field | Type | Description | |-------|------|-------------| -| alive | boolean | | +| alive | boolean | Flag indicating that the app is alive | ## LlamaStackConfiguration diff --git a/docs/output.md b/docs/output.md index 92e9a972e..fb7fca7f2 100644 --- a/docs/output.md +++ b/docs/output.md @@ -687,6 +687,18 @@ Example: | conversations | array | | +## CustomProfile + + +Custom profile customization for prompts and validation. + + +| Field | Type | Description | +|-------|------|-------------| +| path | string | | +| prompts | object | | + + ## Customization @@ -695,9 +707,11 @@ Service customization. | Field | Type | Description | |-------|------|-------------| +| profile_path | | | | disable_query_system_prompt | boolean | | | system_prompt_path | | | | system_prompt | | | +| custom_profile | | | ## DatabaseConfiguration @@ -960,7 +974,7 @@ Example: | Field | Type | Description | |-------|------|-------------| -| alive | boolean | | +| alive | boolean | Flag indicating that the app is alive | ## LlamaStackConfiguration