Skip to content

Commit 82c716c

Browse files
committed
LCORE-1332: Update OpenAPI schema
1 parent be812e7 commit 82c716c

2 files changed

Lines changed: 34 additions & 3 deletions

File tree

docs/openapi.json

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1170,7 +1170,7 @@
11701170
"rags"
11711171
],
11721172
"summary": "Get Rag Endpoint Handler",
1173-
"description": "Retrieve a single RAG by its unique ID.\n\nReturns:\n RAGInfoResponse: A single RAG's details.\n\nRaises:\n HTTPException:\n - 401: Authentication failed\n - 403: Authorization failed\n - 404: RAG with the given ID not found\n - 500: Lightspeed Stack configuration not loaded\n - 503: Unable to connect to Llama Stack",
1173+
"description": "Retrieve a single RAG by its unique ID.\n\nAccepts both user-facing rag_id (from LCORE config) and llama-stack\nvector_store_id. If a rag_id from config is provided, it is resolved\nto the underlying vector_store_id for the llama-stack lookup.\n\nReturns:\n RAGInfoResponse: A single RAG's details.\n\nRaises:\n HTTPException:\n - 401: Authentication failed\n - 403: Authorization failed\n - 404: RAG with the given ID not found\n - 500: Lightspeed Stack configuration not loaded\n - 503: Unable to connect to Llama Stack",
11741174
"operationId": "get_rag_endpoint_handler_v1_rags__rag_id__get",
11751175
"parameters": [
11761176
{
@@ -8349,7 +8349,7 @@
83498349
}
83508350
],
83518351
"title": "Source",
8352-
"description": "Source document or URL"
8352+
"description": "Index name identifying the knowledge source from configuration"
83538353
},
83548354
"score": {
83558355
"anyOf": [
@@ -8362,6 +8362,19 @@
83628362
],
83638363
"title": "Score",
83648364
"description": "Relevance score"
8365+
},
8366+
"attributes": {
8367+
"anyOf": [
8368+
{
8369+
"additionalProperties": true,
8370+
"type": "object"
8371+
},
8372+
{
8373+
"type": "null"
8374+
}
8375+
],
8376+
"title": "Attributes",
8377+
"description": "Document metadata from the RAG provider (e.g., url, title, author)"
83658378
}
83668379
},
83678380
"type": "object",
@@ -8607,6 +8620,18 @@
86078620
],
86088621
"title": "Doc Title",
86098622
"description": "Title of the referenced document"
8623+
},
8624+
"source": {
8625+
"anyOf": [
8626+
{
8627+
"type": "string"
8628+
},
8629+
{
8630+
"type": "null"
8631+
}
8632+
],
8633+
"title": "Source",
8634+
"description": "Index name identifying the knowledge source from configuration"
86108635
}
86118636
},
86128637
"type": "object",

docs/openapi.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,10 @@ Examples
10051005
10061006
Retrieve a single RAG by its unique ID.
10071007

1008+
Accepts both user-facing rag_id (from LCORE config) and llama-stack
1009+
vector_store_id. If a rag_id from config is provided, it is resolved
1010+
to the underlying vector_store_id for the llama-stack lookup.
1011+
10081012
Returns:
10091013
RAGInfoResponse: A single RAG's details.
10101014

@@ -5265,8 +5269,9 @@ Model representing a RAG chunk used in the response.
52655269
| Field | Type | Description |
52665270
|-------|------|-------------|
52675271
| content | string | The content of the chunk |
5268-
| source | | Source document or URL |
5272+
| source | | Index name identifying the knowledge source from configuration |
52695273
| score | | Relevance score |
5274+
| attributes | | Document metadata from the RAG provider (e.g., url, title, author) |
52705275

52715276

52725277
## RAGInfoResponse
@@ -5356,6 +5361,7 @@ Attributes:
53565361
|-------|------|-------------|
53575362
| doc_url | | URL of the referenced document |
53585363
| doc_title | | Title of the referenced document |
5364+
| source | | Index name identifying the knowledge source from configuration |
53595365

53605366

53615367
## RlsapiV1Attachment

0 commit comments

Comments
 (0)