Skip to content

Commit 435155d

Browse files
authored
Merge pull request #1182 from tisnik/lcore-1346-fixed-wrong-rendering
LCORE-1346: fixed wrong OpenAPI doc rendering (1st part)
2 parents c706062 + 9bf9114 commit 435155d

1 file changed

Lines changed: 32 additions & 112 deletions

File tree

docs/openapi.md

Lines changed: 32 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ Returns:
2929

3030
### ✅ Responses
3131

32-
| Status Code | Description | Component |
33-
|-------------|-------------|-----------|
34-
| 200 | Successful Response | string |
35-
| 401 | Unauthorized | ...
36-
Examples
37-
38-
39-
32+
| Status Code | Description | Component |
33+
|-------------|---------------------|-----------------------------------------------|
34+
| 200 | Successful Response | string |
35+
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) |
36+
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) |
4037

38+
Examples
4139

4240
```json
4341
{
@@ -48,9 +46,6 @@ Examples
4846
}
4947
```
5048

51-
52-
53-
5449
```json
5550
{
5651
"detail": {
@@ -60,14 +55,6 @@ Examples
6055
}
6156
```
6257

63-
[UnauthorizedResponse](#unauthorizedresponse) |
64-
| 403 | Permission denied | ...
65-
Examples
66-
67-
68-
69-
70-
7158
```json
7259
{
7360
"detail": {
@@ -77,7 +64,6 @@ Examples
7764
}
7865
```
7966

80-
[ForbiddenResponse](#forbiddenresponse) |
8167
## GET `/v1/info`
8268

8369
> **Info Endpoint Handler**
@@ -102,17 +88,15 @@ Returns:
10288

10389
### ✅ Responses
10490

105-
| Status Code | Description | Component |
106-
|-------------|-------------|-----------|
107-
| 200 | Successful response | [InfoResponse](#inforesponse) |
108-
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse)
91+
| Status Code | Description | Component |
92+
|-------------|---------------------|-----------------------------------------------------------|
93+
| 200 | Successful response | [InfoResponse](#inforesponse) |
94+
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) |
95+
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) |
96+
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) |
10997

11098
Examples
11199

112-
113-
114-
115-
116100
```json
117101
{
118102
"detail": {
@@ -122,9 +106,6 @@ Examples
122106
}
123107
```
124108

125-
126-
127-
128109
```json
129110
{
130111
"detail": {
@@ -134,9 +115,6 @@ Examples
134115
}
135116
```
136117

137-
138-
139-
140118
```json
141119
{
142120
"detail": {
@@ -146,9 +124,6 @@ Examples
146124
}
147125
```
148126

149-
150-
151-
152127
```json
153128
{
154129
"detail": {
@@ -158,9 +133,6 @@ Examples
158133
}
159134
```
160135

161-
162-
163-
164136
```json
165137
{
166138
"detail": {
@@ -170,9 +142,6 @@ Examples
170142
}
171143
```
172144

173-
174-
175-
176145
```json
177146
{
178147
"detail": {
@@ -182,9 +151,6 @@ Examples
182151
}
183152
```
184153

185-
186-
187-
188154
```json
189155
{
190156
"detail": {
@@ -194,9 +160,6 @@ Examples
194160
}
195161
```
196162

197-
198-
199-
200163
```json
201164
{
202165
"detail": {
@@ -205,14 +168,6 @@ Examples
205168
}
206169
}
207170
```
208-
|
209-
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse)
210-
211-
Examples
212-
213-
214-
215-
216171

217172
```json
218173
{
@@ -222,14 +177,6 @@ Examples
222177
}
223178
}
224179
```
225-
|
226-
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse)
227-
228-
Examples
229-
230-
231-
232-
233180

234181
```json
235182
{
@@ -239,7 +186,7 @@ Examples
239186
}
240187
}
241188
```
242-
|
189+
243190
## GET `/v1/models`
244191

245192
> **Models Endpoint Handler**
@@ -272,21 +219,21 @@ will be returned.
272219

273220
### 🔗 Parameters
274221

275-
| Name | Type | Required | Description |
276-
|------|------|----------|-------------|
277-
| model_type | | False | Optional filter to return only models matching this type |
222+
| Name | Type | Required | Description |
223+
|------------|------|----------|----------------------------------------------------------|
224+
| model_type | | False | Optional filter to return only models matching this type |
278225

279226

280227
### ✅ Responses
281228

282-
| Status Code | Description | Component |
283-
|-------------|-------------|-----------|
284-
| 200 | Successful response | [ModelsResponse](#modelsresponse) |
285-
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) |
286-
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) |
287-
| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) |
288-
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) |
289-
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
229+
| Status Code | Description | Component |
230+
|-------------|-----------------------|-------------------------------------------------------------|
231+
| 200 | Successful response | [ModelsResponse](#modelsresponse) |
232+
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) |
233+
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) |
234+
| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) |
235+
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) |
236+
| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) |
290237

291238
Examples
292239

@@ -358,17 +305,16 @@ Returns:
358305

359306
### ✅ Responses
360307

361-
| Status Code | Description | Component |
362-
|-------------|-------------|-----------|
363-
| 200 | Successful response | [ToolsResponse](#toolsresponse) |
364-
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse)
308+
| Status Code | Description | Component |
309+
|-------------|-----------------------|-------------------------------------------------------------|
310+
| 200 | Successful response | [ToolsResponse](#toolsresponse) |
311+
| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) |
312+
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) |
313+
| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) |
314+
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) |
365315

366316
Examples
367317

368-
369-
370-
371-
372318
```json
373319
{
374320
"detail": {
@@ -378,9 +324,6 @@ Examples
378324
}
379325
```
380326

381-
382-
383-
384327
```json
385328
{
386329
"detail": {
@@ -389,14 +332,6 @@ Examples
389332
}
390333
}
391334
```
392-
|
393-
| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse)
394-
395-
Examples
396-
397-
398-
399-
400335

401336
```json
402337
{
@@ -406,13 +341,6 @@ Examples
406341
}
407342
}
408343
```
409-
|
410-
| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse)
411-
412-
Examples
413-
414-
415-
416344

417345

418346
```json
@@ -423,14 +351,6 @@ Examples
423351
}
424352
}
425353
```
426-
|
427-
| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse)
428-
429-
Examples
430-
431-
432-
433-
434354

435355
```json
436356
{
@@ -440,7 +360,7 @@ Examples
440360
}
441361
}
442362
```
443-
|
363+
444364
## GET `/v1/mcp-auth/client-options`
445365

446366
> **Get Mcp Client Auth Options**

0 commit comments

Comments
 (0)