Skip to content

Commit 0f4476c

Browse files
authored
Merge pull request #386 from tisnik/fixed-openapi-documentation-formatting
Fixed OpenAPI documentation formatting
2 parents 701065b + 6a38835 commit 0f4476c

File tree

1 file changed

+27
-50
lines changed

1 file changed

+27
-50
lines changed

docs/openapi.md

Lines changed: 27 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ Handle requests to the /models endpoint.
6363

6464
| Status Code | Description | Component |
6565
|-------------|-------------|-----------|
66-
| 200 | Successful Response | [ModelsResponse](#modelsresponse)
67-
|
66+
| 200 | Successful Response | [ModelsResponse](#modelsresponse) |
6867
| 503 | Connection to Llama Stack is broken | |
68+
6969
## POST `/v1/query`
7070

7171
> **Query Endpoint Handler**
@@ -84,15 +84,11 @@ Handle request to the /query endpoint.
8484

8585
| Status Code | Description | Component |
8686
|-------------|-------------|-----------|
87-
| 200 | Successful Response | [QueryResponse](#queryresponse)
88-
|
89-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
90-
|
91-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
92-
|
87+
| 200 | Successful Response | [QueryResponse](#queryresponse) |
88+
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
89+
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
9390
| 503 | Service Unavailable | |
94-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
95-
|
91+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
9692
## POST `/v1/streaming_query`
9793

9894
> **Streaming Query Endpoint Handler**
@@ -112,8 +108,7 @@ Handle request to the /streaming_query endpoint.
112108
| Status Code | Description | Component |
113109
|-------------|-------------|-----------|
114110
| 200 | Successful Response | ... |
115-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
116-
|
111+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
117112
## GET `/v1/config`
118113

119114
> **Config Endpoint Handler**
@@ -134,8 +129,7 @@ Returns:
134129

135130
| Status Code | Description | Component |
136131
|-------------|-------------|-----------|
137-
| 200 | Successful Response | [Configuration](#configuration)
138-
|
132+
| 200 | Successful Response | [Configuration](#configuration) |
139133
| 503 | Service Unavailable | |
140134
## POST `/v1/feedback`
141135

@@ -165,16 +159,11 @@ Returns:
165159

166160
| Status Code | Description | Component |
167161
|-------------|-------------|-----------|
168-
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse)
169-
|
170-
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
171-
|
172-
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse)
173-
|
174-
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse)
175-
|
176-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
177-
|
162+
| 200 | Feedback received and stored | [FeedbackResponse](#feedbackresponse) |
163+
| 401 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
164+
| 403 | Client does not have permission to access resource | [ForbiddenResponse](#forbiddenresponse) |
165+
| 500 | User feedback can not be stored | [ErrorResponse](#errorresponse) |
166+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
178167
## GET `/v1/feedback/status`
179168

180169
> **Feedback Status**
@@ -192,8 +181,7 @@ Returns:
192181

193182
| Status Code | Description | Component |
194183
|-------------|-------------|-----------|
195-
| 200 | Successful Response | [StatusResponse](#statusresponse)
196-
|
184+
| 200 | Successful Response | [StatusResponse](#statusresponse) |
197185
## GET `/v1/conversations`
198186

199187
> **Get Conversations List Endpoint Handler**
@@ -208,8 +196,7 @@ Handle request to retrieve all conversations for the authenticated user.
208196

209197
| Status Code | Description | Component |
210198
|-------------|-------------|-----------|
211-
| 200 | Successful Response | [ConversationsListResponse](#conversationslistresponse)
212-
|
199+
| 200 | Successful Response | [ConversationsListResponse](#conversationslistresponse) |
213200
| 503 | Service Unavailable | |
214201
## GET `/v1/conversations/{conversation_id}`
215202

@@ -230,12 +217,10 @@ Handle request to retrieve a conversation by ID.
230217

231218
| Status Code | Description | Component |
232219
|-------------|-------------|-----------|
233-
| 200 | Successful Response | [ConversationResponse](#conversationresponse)
234-
|
220+
| 200 | Successful Response | [ConversationResponse](#conversationresponse) |
235221
| 404 | Not Found | |
236222
| 503 | Service Unavailable | |
237-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
238-
|
223+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
239224
## DELETE `/v1/conversations/{conversation_id}`
240225

241226
> **Delete Conversation Endpoint Handler**
@@ -255,12 +240,10 @@ Handle request to delete a conversation by ID.
255240

256241
| Status Code | Description | Component |
257242
|-------------|-------------|-----------|
258-
| 200 | Successful Response | [ConversationDeleteResponse](#conversationdeleteresponse)
259-
|
243+
| 200 | Successful Response | [ConversationDeleteResponse](#conversationdeleteresponse) |
260244
| 404 | Not Found | |
261245
| 503 | Service Unavailable | |
262-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror)
263-
|
246+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
264247
## GET `/readiness`
265248

266249
> **Readiness Probe Get Method**
@@ -279,10 +262,8 @@ service is ready.
279262

280263
| Status Code | Description | Component |
281264
|-------------|-------------|-----------|
282-
| 200 | Service is ready | [ReadinessResponse](#readinessresponse)
283-
|
284-
| 503 | Service is not ready | [ReadinessResponse](#readinessresponse)
285-
|
265+
| 200 | Service is ready | [ReadinessResponse](#readinessresponse) |
266+
| 503 | Service is not ready | [ReadinessResponse](#readinessresponse) |
286267
## GET `/liveness`
287268

288269
> **Liveness Probe Get Method**
@@ -300,10 +281,8 @@ Returns:
300281

301282
| Status Code | Description | Component |
302283
|-------------|-------------|-----------|
303-
| 200 | Service is alive | [LivenessResponse](#livenessresponse)
304-
|
305-
| 503 | Service is not alive | [LivenessResponse](#livenessresponse)
306-
|
284+
| 200 | Service is alive | [LivenessResponse](#livenessresponse) |
285+
| 503 | Service is not alive | [LivenessResponse](#livenessresponse) |
307286
## POST `/authorized`
308287

309288
> **Authorized Endpoint Handler**
@@ -324,12 +303,9 @@ Returns:
324303

325304
| Status Code | Description | Component |
326305
|-------------|-------------|-----------|
327-
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse)
328-
|
329-
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse)
330-
|
331-
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse)
332-
|
306+
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse) |
307+
| 400 | Missing or invalid credentials provided by client | [UnauthorizedResponse](#unauthorizedresponse) |
308+
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
333309
## GET `/metrics`
334310

335311
> **Metrics Endpoint Handler**
@@ -1051,3 +1027,4 @@ User data collection configuration.
10511027
| loc | array | |
10521028
| msg | string | |
10531029
| type | string | |
1030+

0 commit comments

Comments
 (0)