Skip to content

Commit f13abb3

Browse files
committed
Updated description for /readines endpoint
1 parent 3e2aca9 commit f13abb3

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

src/app/endpoints/health.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,14 @@ async def readiness_probe_get_method(
127127
- response: The outgoing HTTP response (used by middleware).
128128
- auth: Authentication tuple from the auth dependency (used by middleware).
129129
130+
### Raises:
131+
- HTTPException: with status 401 for unauthorized access.
132+
- HTTPException: with status 403 if permission is denied.
133+
- HTTPException: with status 500 and a detail object containing `response`
134+
and `cause` when service configuration is wrong or incomplete.
135+
- HTTPException: with status 503 and a detail object containing `response`
136+
and `cause` when unable to connect to Llama Stack.
137+
130138
### Returns:
131139
- ReadinessResponse: Object with `ready` indicating overall readiness,
132140
`reason` explaining the outcome, and `providers` containing the list of

0 commit comments

Comments
 (0)