Skip to content

Commit 5bb465b

Browse files
committed
Updated description for /rags endpoint
1 parent 811dca6 commit 5bb465b

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

src/app/endpoints/rags.py

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,20 @@ async def rags_endpoint_handler(
6262
"""
6363
List all available RAGs.
6464
65-
Returns:
66-
RAGListResponse: List of RAG identifiers.
67-
68-
Raises:
69-
HTTPException:
70-
- 401: Authentication failed
71-
- 403: Authorization failed
72-
- 500: Lightspeed Stack configuration not loaded
73-
- 503: Unable to connect to Llama Stack
65+
### Parameters:
66+
- request: The incoming HTTP request (used by middleware).
67+
- auth: Authentication tuple from the auth dependency (used by middleware).
68+
69+
### Raises:
70+
- HTTPException: with status 401 for unauthorized access.
71+
- HTTPException: with status 403 if permission is denied.
72+
- HTTPException: with status 500 and a detail object containing `response`
73+
and `cause` when service configuration is wrong or incomplete.
74+
- HTTPException: with status 503 and a detail object containing `response`
75+
and `cause` when unable to connect to Llama Stack.
76+
77+
### Returns:
78+
- RAGListResponse: List of RAG identifiers.
7479
"""
7580
# Used only by the middleware
7681
_ = auth

0 commit comments

Comments
 (0)