Skip to content

Commit 52408e8

Browse files
tisniktisnik
committed
Regenerated OpenAPI specification + documentation
1 parent eef9092 commit 52408e8

File tree

4 files changed

+77
-41
lines changed

4 files changed

+77
-41
lines changed

‎docs/openapi.json‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1718,11 +1718,18 @@
17181718
"properties": {
17191719
"provider_id": {
17201720
"type": "string",
1721-
"title": "Provider Id"
1721+
"title": "Provider Id",
1722+
"description": "The ID of the provider"
17221723
},
17231724
"status": {
17241725
"type": "string",
1725-
"title": "Status"
1726+
"title": "Status",
1727+
"description": "The health status",
1728+
"examples": [
1729+
"ok",
1730+
"unhealthy",
1731+
"not_implemented"
1732+
]
17261733
},
17271734
"message": {
17281735
"anyOf": [
@@ -1733,7 +1740,12 @@
17331740
"type": "null"
17341741
}
17351742
],
1736-
"title": "Message"
1743+
"title": "Message",
1744+
"description": "Optional message about the health status",
1745+
"examples": [
1746+
"All systems operational",
1747+
"Llama Stack is unavailable"
1748+
]
17371749
}
17381750
},
17391751
"type": "object",
@@ -1980,7 +1992,7 @@
19801992
"providers"
19811993
],
19821994
"title": "ReadinessResponse",
1983-
"description": "Model representing response to a readiness request.\n\nAttributes:\n ready: If service is ready.\n reason: The reason for the readiness.\n providers: List of unhealthy providers in case of readiness failure.\n\nExample:\n ```python\n readiness_response = ReadinessResponse(\n ready=False,\n reason=\"Service is not ready\",\n providers=[\n ProviderHealthStatus(\n provider_id=\"ollama\",\n status=\"Error\",\n message=\"Server is unavailable\"\n )\n ]\n )\n ```",
1995+
"description": "Model representing response to a readiness request.\n\nAttributes:\n ready: If service is ready.\n reason: The reason for the readiness.\n providers: List of unhealthy providers in case of readiness failure.\n\nExample:\n ```python\n readiness_response = ReadinessResponse(\n ready=False,\n reason=\"Service is not ready\",\n providers=[\n ProviderHealthStatus(\n provider_id=\"ollama\",\n status=\"unhealthy\",\n message=\"Server is unavailable\"\n )\n ]\n )\n ```",
19841996
"examples": [
19851997
{
19861998
"providers": [],

‎docs/openapi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -907,9 +907,9 @@ Attributes:
907907

908908
| Field | Type | Description |
909909
|-------|------|-------------|
910-
| provider_id | string | |
911-
| status | string | |
912-
| message | | |
910+
| provider_id | string | The ID of the provider |
911+
| status | string | The health status |
912+
| message | | Optional message about the health status |
913913

914914

915915
## QueryRequest
@@ -978,7 +978,7 @@ Example:
978978
providers=[
979979
ProviderHealthStatus(
980980
provider_id="ollama",
981-
status="Error",
981+
status="unhealthy",
982982
message="Server is unavailable"
983983
)
984984
]

‎docs/output.md‎

Lines changed: 54 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ Returns:
7474

7575
| Status Code | Description | Component |
7676
|-------------|-------------|-----------|
77-
| 200 | Successful Response | [ModelsResponse](#modelsresponse) |
77+
| 200 | Successful Response | [ModelsResponse](#modelsresponse)
78+
|
7879
| 503 | Connection to Llama Stack is broken | |
79-
8080
## POST `/v1/query`
8181

8282
> **Query Endpoint Handler**
@@ -107,11 +107,15 @@ Returns:
107107

108108
| Status Code | Description | Component |
109109
|-------------|-------------|-----------|
110-
| 200 | Successful Response | [QueryResponse](#queryresponse) |
111-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
112-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
110+
| 200 | Successful Response | [QueryResponse](#queryresponse)
111+
|
112+
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
113+
|
114+
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
115+
|
113116
| 503 | Service Unavailable | |
114-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
117+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
118+
|
115119
## POST `/v1/streaming_query`
116120

117121
> **Streaming Query Endpoint Handler**
@@ -146,7 +150,8 @@ Raises:
146150
| Status Code | Description | Component |
147151
|-------------|-------------|-----------|
148152
| 200 | Successful Response | ... |
149-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
153+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
154+
|
150155
## GET `/v1/config`
151156

152157
> **Config Endpoint Handler**
@@ -167,7 +172,8 @@ Returns:
167172

168173
| Status Code | Description | Component |
169174
|-------------|-------------|-----------|
170-
| 200 | Successful Response | [Configuration](#configuration) |
175+
| 200 | Successful Response | [Configuration](#configuration)
176+
|
171177
| 503 | Service Unavailable | |
172178
## POST `/v1/feedback`
173179

@@ -203,11 +209,16 @@ Raises:
203209

204210
| Status Code | Description | Component |
205211
|-------------|-------------|-----------|
206-
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse) |
207-
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
208-
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse) |
209-
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse) |
210-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
212+
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse)
213+
|
214+
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
215+
|
216+
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse)
217+
|
218+
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse)
219+
|
220+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
221+
|
211222
## GET `/v1/feedback/status`
212223

213224
> **Feedback Status**
@@ -228,7 +239,8 @@ Returns:
228239

229240
| Status Code | Description | Component |
230241
|-------------|-------------|-----------|
231-
| 200 | Successful Response | [StatusResponse](#statusresponse) |
242+
| 200 | Successful Response | [StatusResponse](#statusresponse)
243+
|
232244
## GET `/v1/conversations`
233245

234246
> **Get Conversations List Endpoint Handler**
@@ -243,7 +255,8 @@ Handle request to retrieve all conversations for the authenticated user.
243255

244256
| Status Code | Description | Component |
245257
|-------------|-------------|-----------|
246-
| 200 | Successful Response | [ConversationsListResponse](#conversationslistresponse) |
258+
| 200 | Successful Response | [ConversationsListResponse](#conversationslistresponse)
259+
|
247260
| 503 | Service Unavailable | |
248261
## GET `/v1/conversations/{conversation_id}`
249262

@@ -278,10 +291,12 @@ Returns:
278291

279292
| Status Code | Description | Component |
280293
|-------------|-------------|-----------|
281-
| 200 | Successful Response | [ConversationResponse](#conversationresponse) |
294+
| 200 | Successful Response | [ConversationResponse](#conversationresponse)
295+
|
282296
| 404 | Not Found | |
283297
| 503 | Service Unavailable | |
284-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
298+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
299+
|
285300
## DELETE `/v1/conversations/{conversation_id}`
286301

287302
> **Delete Conversation Endpoint Handler**
@@ -309,10 +324,12 @@ Returns:
309324

310325
| Status Code | Description | Component |
311326
|-------------|-------------|-----------|
312-
| 200 | Successful Response | [ConversationDeleteResponse](#conversationdeleteresponse) |
327+
| 200 | Successful Response | [ConversationDeleteResponse](#conversationdeleteresponse)
328+
|
313329
| 404 | Not Found | |
314330
| 503 | Service Unavailable | |
315-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
331+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
332+
|
316333
## GET `/readiness`
317334

318335
> **Readiness Probe Get Method**
@@ -331,8 +348,10 @@ service is ready.
331348

332349
| Status Code | Description | Component |
333350
|-------------|-------------|-----------|
334-
| 200 | Service is ready | [ReadinessResponse](#readinessresponse) |
335-
| 503 | Service is not ready | [ReadinessResponse](#readinessresponse) |
351+
| 200 | Service is ready | [ReadinessResponse](#readinessresponse)
352+
|
353+
| 503 | Service is not ready | [ReadinessResponse](#readinessresponse)
354+
|
336355
## GET `/liveness`
337356

338357
> **Liveness Probe Get Method**
@@ -350,8 +369,10 @@ Returns:
350369

351370
| Status Code | Description | Component |
352371
|-------------|-------------|-----------|
353-
| 200 | Service is alive | [LivenessResponse](#livenessresponse) |
354-
| 503 | Service is not alive | [LivenessResponse](#livenessresponse) |
372+
| 200 | Service is alive | [LivenessResponse](#livenessresponse)
373+
|
374+
| 503 | Service is not alive | [LivenessResponse](#livenessresponse)
375+
|
355376
## POST `/authorized`
356377

357378
> **Authorized Endpoint Handler**
@@ -372,9 +393,12 @@ Returns:
372393

373394
| Status Code | Description | Component |
374395
|-------------|-------------|-----------|
375-
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse) |
376-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
377-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
396+
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse)
397+
|
398+
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
399+
|
400+
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
401+
|
378402
## GET `/metrics`
379403

380404
> **Metrics Endpoint Handler**
@@ -897,9 +921,9 @@ Attributes:
897921

898922
| Field | Type | Description |
899923
|-------|------|-------------|
900-
| provider_id | string | |
901-
| status | string | |
902-
| message | | |
924+
| provider_id | string | The ID of the provider |
925+
| status | string | The health status |
926+
| message | | Optional message about the health status |
903927

904928

905929
## QueryRequest
@@ -968,7 +992,7 @@ Example:
968992
providers=[
969993
ProviderHealthStatus(
970994
provider_id="ollama",
971-
status="Error",
995+
status="unhealthy",
972996
message="Server is unavailable"
973997
)
974998
]

‎src/models/responses.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ class ProviderHealthStatus(BaseModel):
136136
)
137137
message: Optional[str] = Field(
138138
None,
139-
description="Optinal message about the health status",
140-
examples=["ok"],
139+
description="Optional message about the health status",
140+
examples=["All systems operational", "Llama Stack is unavailable"],
141141
)
142142

143143

@@ -157,7 +157,7 @@ class ReadinessResponse(BaseModel):
157157
providers=[
158158
ProviderHealthStatus(
159159
provider_id="ollama",
160-
status="Error",
160+
status="unhealthy",
161161
message="Server is unavailable"
162162
)
163163
]

0 commit comments

Comments
 (0)