Skip to content

Commit 6421f35

Browse files
tisniktisnik
committed
Regenerated OpenAPI specification
1 parent 053090b commit 6421f35

File tree

4 files changed

+179
-114
lines changed

4 files changed

+179
-114
lines changed

‎docs/openapi.json‎

Lines changed: 73 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"models"
7575
],
7676
"summary": "Models Endpoint Handler",
77-
"description": "Handle requests to the /models endpoint.",
77+
"description": "Handle requests to the /models endpoint.\n\nProcess GET requests to the /models endpoint, returning a list of available\nmodels from the Llama Stack service.\n\nRaises:\n HTTPException: If unable to connect to the Llama Stack server or if\n model retrieval fails for any reason.\n\nReturns:\n ModelsResponse: An object containing the list of available models.",
7878
"operationId": "models_endpoint_handler_v1_models_get",
7979
"responses": {
8080
"200": {
@@ -300,7 +300,7 @@
300300
"feedback"
301301
],
302302
"summary": "Feedback Endpoint Handler",
303-
"description": "Handle feedback requests.\n\nArgs:\n feedback_request: The request containing feedback information.\n ensure_feedback_enabled: The feedback handler (FastAPI Depends) that\n will handle feedback status checks.\n auth: The Authentication handler (FastAPI Depends) that will\n handle authentication Logic.\n\nReturns:\n Response indicating the status of the feedback storage request.",
303+
"description": "Handle feedback requests.\n\nProcesses a user feedback submission, storing the feedback and\nreturning a confirmation response.\n\nArgs:\n feedback_request: The request containing feedback information.\n ensure_feedback_enabled: The feedback handler (FastAPI Depends) that\n will handle feedback status checks.\n auth: The Authentication handler (FastAPI Depends) that will\n handle authentication Logic.\n\nReturns:\n Response indicating the status of the feedback storage request.\n\nRaises:\n HTTPException: Returns HTTP 500 if feedback storage fails.",
304304
"operationId": "feedback_endpoint_handler_v1_feedback_post",
305305
"requestBody": {
306306
"content": {
@@ -372,7 +372,7 @@
372372
"feedback"
373373
],
374374
"summary": "Feedback Status",
375-
"description": "Handle feedback status requests.\n\nReturns:\n Response indicating the status of the feedback.",
375+
"description": "Handle feedback status requests.\n\nReturn the current enabled status of the feedback\nfunctionality.\n\nReturns:\n StatusResponse: Indicates whether feedback collection is enabled.",
376376
"operationId": "feedback_status_v1_feedback_status_get",
377377
"responses": {
378378
"200": {
@@ -441,7 +441,7 @@
441441
"conversations"
442442
],
443443
"summary": "Get Conversation Endpoint Handler",
444-
"description": "Handle request to retrieve a conversation by ID.",
444+
"description": "Handle request to retrieve a conversation by ID.\n\nRetrieve a conversation's chat history by its ID. Then fetches\nthe conversation session from the Llama Stack backend,\nsimplifies the session data to essential chat history, and\nreturns it in a structured response. Raises HTTP 400 for\ninvalid IDs, 404 if not found, 503 if the backend is\nunavailable, and 500 for unexpected errors.\n\nParameters:\n conversation_id (str): Unique identifier of the conversation to retrieve.\n\nReturns:\n ConversationResponse: Structured response containing the conversation\n ID and simplified chat history.",
445445
"operationId": "get_conversation_endpoint_handler_v1_conversations__conversation_id__get",
446446
"parameters": [
447447
{
@@ -513,7 +513,7 @@
513513
"conversations"
514514
],
515515
"summary": "Delete Conversation Endpoint Handler",
516-
"description": "Handle request to delete a conversation by ID.",
516+
"description": "Handle request to delete a conversation by ID.\n\nValidates the conversation ID format and attempts to delete the\ncorresponding session from the Llama Stack backend. Raises HTTP\nerrors for invalid IDs, not found conversations, connection\nissues, or unexpected failures.\n\nReturns:\n ConversationDeleteResponse: Response indicating the result of the deletion operation.",
517517
"operationId": "delete_conversation_endpoint_handler_v1_conversations__conversation_id__delete",
518518
"parameters": [
519519
{
@@ -807,11 +807,20 @@
807807
"properties": {
808808
"user_id": {
809809
"type": "string",
810-
"title": "User Id"
810+
"title": "User Id",
811+
"description": "User ID, for example UUID",
812+
"examples": [
813+
"c5260aec-4d82-4370-9fdf-05cf908b3f16"
814+
]
811815
},
812816
"username": {
813817
"type": "string",
814-
"title": "Username"
818+
"title": "Username",
819+
"description": "User name",
820+
"examples": [
821+
"John Doe",
822+
"Adam Smith"
823+
]
815824
}
816825
},
817826
"type": "object",
@@ -860,14 +869,7 @@
860869
"default": []
861870
},
862871
"authentication": {
863-
"anyOf": [
864-
{
865-
"$ref": "#/components/schemas/AuthenticationConfiguration"
866-
},
867-
{
868-
"type": "null"
869-
}
870-
],
872+
"$ref": "#/components/schemas/AuthenticationConfiguration",
871873
"default": {
872874
"module": "noop",
873875
"skip_tls_verification": false
@@ -1140,41 +1142,25 @@
11401142
"title": "DatabaseConfiguration",
11411143
"description": "Database configuration."
11421144
},
1143-
"DatabaseConfiguration": {
1144-
"properties": {
1145-
"sqlite": {
1146-
"anyOf": [
1147-
{
1148-
"$ref": "#/components/schemas/SQLiteDatabaseConfiguration"
1149-
},
1150-
{
1151-
"type": "null"
1152-
}
1153-
]
1154-
},
1155-
"postgres": {
1156-
"anyOf": [
1157-
{
1158-
"$ref": "#/components/schemas/PostgreSQLDatabaseConfiguration"
1159-
},
1160-
{
1161-
"type": "null"
1162-
}
1163-
]
1164-
}
1165-
},
1166-
"type": "object",
1167-
"title": "DatabaseConfiguration",
1168-
"description": "Database configuration."
1169-
},
11701145
"ErrorResponse": {
11711146
"properties": {
11721147
"detail": {
11731148
"additionalProperties": {
11741149
"type": "string"
11751150
},
11761151
"type": "object",
1177-
"title": "Detail"
1152+
"title": "Detail",
1153+
"description": "Error details",
1154+
"examples": [
1155+
{
1156+
"cause": "Failed to handle request to https://bam-api.res.ibm.com/v2/text",
1157+
"response": "Error while validation question"
1158+
},
1159+
{
1160+
"cause": "Invalid conversation ID 1237-e89b-12d3-a456-426614174000",
1161+
"response": "Error retrieving conversation history"
1162+
}
1163+
]
11781164
}
11791165
},
11801166
"type": "object",
@@ -1413,11 +1399,21 @@
14131399
"properties": {
14141400
"name": {
14151401
"type": "string",
1416-
"title": "Name"
1402+
"title": "Name",
1403+
"description": "Service name",
1404+
"examples": [
1405+
"Lightspeed Stack"
1406+
]
14171407
},
14181408
"version": {
14191409
"type": "string",
1420-
"title": "Version"
1410+
"title": "Version",
1411+
"description": "Service version",
1412+
"examples": [
1413+
"0.1.0",
1414+
"0.2.0",
1415+
"1.0.0"
1416+
]
14211417
}
14221418
},
14231419
"type": "object",
@@ -1576,7 +1572,28 @@
15761572
"type": "object"
15771573
},
15781574
"type": "array",
1579-
"title": "Models"
1575+
"title": "Models",
1576+
"description": "List of models available",
1577+
"examples": [
1578+
{
1579+
"api_model_type": "llm",
1580+
"identifier": "openai/gpt-4-turbo",
1581+
"metadata": {},
1582+
"model_type": "llm",
1583+
"provider_id": "openai",
1584+
"provider_resource_id": "gpt-4-turbo",
1585+
"type": "model"
1586+
},
1587+
{
1588+
"api_model_type": "llm",
1589+
"identifier": "openai/gpt-3.5-turbo-0125",
1590+
"metadata": {},
1591+
"model_type": "llm",
1592+
"provider_id": "openai",
1593+
"provider_resource_id": "gpt-3.5-turbo-0125",
1594+
"type": "model"
1595+
}
1596+
]
15801597
}
15811598
},
15821599
"type": "object",
@@ -1867,11 +1884,19 @@
18671884
"type": "null"
18681885
}
18691886
],
1870-
"title": "Conversation Id"
1887+
"title": "Conversation Id",
1888+
"description": "The optional conversation ID (UUID)",
1889+
"examples": [
1890+
"c5260aec-4d82-4370-9fdf-05cf908b3f16"
1891+
]
18711892
},
18721893
"response": {
18731894
"type": "string",
1874-
"title": "Response"
1895+
"title": "Response",
1896+
"description": "Response from LLM",
1897+
"examples": [
1898+
"Kubernetes is an open-source container orchestration system for automating ..."
1899+
]
18751900
}
18761901
},
18771902
"type": "object",

‎docs/openapi.md‎

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,11 @@ Returns:
171171
172172
Handle feedback status requests.
173173

174+
Return the current enabled status of the feedback
175+
functionality.
176+
174177
Returns:
175-
Response indicating the status of the feedback.
178+
StatusResponse: Indicates whether feedback collection is enabled.
176179

177180

178181

@@ -205,6 +208,20 @@ Handle request to retrieve all conversations for the authenticated user.
205208
206209
Handle request to retrieve a conversation by ID.
207210

211+
Retrieve a conversation's chat history by its ID. Then fetches
212+
the conversation session from the Llama Stack backend,
213+
simplifies the session data to essential chat history, and
214+
returns it in a structured response. Raises HTTP 400 for
215+
invalid IDs, 404 if not found, 503 if the backend is
216+
unavailable, and 500 for unexpected errors.
217+
218+
Parameters:
219+
conversation_id (str): Unique identifier of the conversation to retrieve.
220+
221+
Returns:
222+
ConversationResponse: Structured response containing the conversation
223+
ID and simplified chat history.
224+
208225

209226

210227
### 🔗 Parameters
@@ -228,6 +245,14 @@ Handle request to retrieve a conversation by ID.
228245
229246
Handle request to delete a conversation by ID.
230247

248+
Validates the conversation ID format and attempts to delete the
249+
corresponding session from the Llama Stack backend. Raises HTTP
250+
errors for invalid IDs, not found conversations, connection
251+
issues, or unexpected failures.
252+
253+
Returns:
254+
ConversationDeleteResponse: Response indicating the result of the deletion operation.
255+
231256

232257

233258
### 🔗 Parameters
@@ -391,8 +416,8 @@ Attributes:
391416

392417
| Field | Type | Description |
393418
|-------|------|-------------|
394-
| user_id | string | |
395-
| username | string | |
419+
| user_id | string | User ID, for example UUID |
420+
| username | string | User name |
396421

397422

398423
## Configuration
@@ -556,8 +581,6 @@ Service customization.
556581
| system_prompt | | |
557582

558583

559-
560-
561584
## DatabaseConfiguration
562585

563586

@@ -578,7 +601,7 @@ Model representing error response for query endpoint.
578601

579602
| Field | Type | Description |
580603
|-------|------|-------------|
581-
| detail | object | |
604+
| detail | object | Error details |
582605

583606

584607
## FeedbackCategory
@@ -710,8 +733,8 @@ Example:
710733

711734
| Field | Type | Description |
712735
|-------|------|-------------|
713-
| name | string | |
714-
| version | string | |
736+
| name | string | Service name |
737+
| version | string | Service version |
715738

716739

717740
## JwkConfiguration
@@ -792,7 +815,7 @@ Model representing a response to models request.
792815

793816
| Field | Type | Description |
794817
|-------|------|-------------|
795-
| models | array | |
818+
| models | array | List of models available |
796819

797820

798821
## PostgreSQLDatabaseConfiguration
@@ -876,8 +899,8 @@ Attributes:
876899

877900
| Field | Type | Description |
878901
|-------|------|-------------|
879-
| conversation_id | | |
880-
| response | string | |
902+
| conversation_id | | The optional conversation ID (UUID) |
903+
| response | string | Response from LLM |
881904

882905

883906
## ReadinessResponse
@@ -1012,4 +1035,3 @@ User data collection configuration.
10121035
| loc | array | |
10131036
| msg | string | |
10141037
| type | string | |
1015-

0 commit comments

Comments
 (0)