Skip to content

LCORE-390: field description for liveness response #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2025
Merged

LCORE-390: field description for liveness response #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33bd4cb
LCORE-390: Field description for liveness response model
tisnik Sep 16, 2025
abd781d
Updated OpenAPI schema
tisnik Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
19 changes: 16 additions & 3 deletions docs/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,18 @@ Example:
| conversations | array | |


## CustomProfile


Custom profile customization for prompts and validation.


| Field | Type | Description |
|-------|------|-------------|
| path | string | |
| prompts | object | |


## Customization


Expand All @@ -695,9 +707,11 @@ Service customization.

| Field | Type | Description |
|-------|------|-------------|
| profile_path | | |
| disable_query_system_prompt | boolean | |
| system_prompt_path | | |
| system_prompt | | |
| custom_profile | | |


## DatabaseConfiguration
Expand Down Expand Up @@ -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?",
Expand Down Expand Up @@ -970,7 +983,7 @@ Example:

| Field | Type | Description |
|-------|------|-------------|
| alive | boolean | |
| alive | boolean | Flag indicating that the app is alive |


## LlamaStackConfiguration
Expand Down
16 changes: 15 additions & 1 deletion docs/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,18 @@ Example:
| conversations | array | |


## CustomProfile


Custom profile customization for prompts and validation.


| Field | Type | Description |
|-------|------|-------------|
| path | string | |
| prompts | object | |


## Customization


Expand All @@ -695,9 +707,11 @@ Service customization.

| Field | Type | Description |
|-------|------|-------------|
| profile_path | | |
| disable_query_system_prompt | boolean | |
| system_prompt_path | | |
| system_prompt | | |
| custom_profile | | |


## DatabaseConfiguration
Expand Down Expand Up @@ -960,7 +974,7 @@ Example:

| Field | Type | Description |
|-------|------|-------------|
| alive | boolean | |
| alive | boolean | Flag indicating that the app is alive |


## LlamaStackConfiguration
Expand Down
6 changes: 5 additions & 1 deletion src/models/responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
Loading