Skip to content

Commit 15939db

Browse files
tisniktisnik
committed
Generaded OpenAPI specification
1 parent e11e56c commit 15939db

2 files changed

Lines changed: 36 additions & 26 deletions

File tree

‎docs/openapi.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,7 @@
15001500
"shields"
15011501
],
15021502
"summary": "Shields Endpoint Handler",
1503-
"description": "Handle requests to the /shields endpoint.\n\nProcess GET requests to the /shields endpoint, returning a list of available\nshields from the Llama Stack service.\n\n### Parameters:\n- request: The incoming HTTP request (used by middleware).\n- auth: Authentication tuple from the auth dependency (used by middleware).\n\n### Returns:\n- ShieldsResponse: An object containing the list of available shields.\n\n### Raises:\n- HTTPException: If unable to connect to the Llama Stack server or if\n shield retrieval fails for any reason.",
1503+
"description": "Handle requests to the /shields endpoint.\n\nProcess GET requests to the /shields endpoint, returning a list of available\nshields from the Llama Stack service.\n\n### Parameters:\n- request: The incoming HTTP request (used by middleware).\n- auth: Authentication tuple from the auth dependency (used by middleware).\n\n### Raises:\n- HTTPException: with status 401 for unauthorized access.\n- HTTPException: with status 403 if permission is denied.\n- HTTPException: with status 500 and a detail object containing `response`\n and `cause` when service configuration is wrong or incomplete.\n- HTTPException: with status 503 and a detail object containing `response`\n and `cause` when unable to connect to Llama Stack.\n\n### Returns:\n- ShieldsResponse: An object containing the list of available shields.",
15041504
"operationId": "shields_endpoint_handler_v1_shields_get",
15051505
"responses": {
15061506
"200": {
@@ -1677,7 +1677,7 @@
16771677
"providers"
16781678
],
16791679
"summary": "Providers Endpoint Handler",
1680-
"description": "List all available providers grouped by API type.\n\n### Parameters:\n- request: The incoming HTTP request.\n- auth: Authentication tuple from the auth dependency.\n\n### Returns:\n- ProvidersListResponse: Mapping from API type to list of providers.\n\n### Raises:\n- HTTPException:\n- 401: Authentication failed\n- 403: Authorization failed\n- 500: Lightspeed Stack configuration not loaded\n- 503: Unable to connect to Llama Stack",
1680+
"description": "List all available providers grouped by API type.\n\n### Parameters:\n- request: The incoming HTTP request.\n- auth: Authentication tuple from the auth dependency.\n\n### Raises:\n- HTTPException: with status 401 for unauthorized access.\n- HTTPException: with status 403 if permission is denied.\n- HTTPException: with status 500 and a detail object containing `response`\n and `cause` when service configuration is wrong or incomplete.\n- HTTPException: with status 503 and a detail object containing `response`\n and `cause` when unable to connect to Llama Stack.\n\n### Returns:\n- ProvidersListResponse: Mapping from API type to list of providers.",
16811681
"operationId": "providers_endpoint_handler_v1_providers_get",
16821682
"responses": {
16831683
"200": {
@@ -3211,7 +3211,7 @@
32113211
"rags"
32123212
],
32133213
"summary": "Rags Endpoint Handler",
3214-
"description": "List all available RAGs.\n\nReturns:\n RAGListResponse: List of RAG identifiers.\n\nRaises:\n HTTPException:\n - 401: Authentication failed\n - 403: Authorization failed\n - 500: Lightspeed Stack configuration not loaded\n - 503: Unable to connect to Llama Stack",
3214+
"description": "List all available RAGs.\n\n### Parameters:\n- request: The incoming HTTP request (used by middleware).\n- auth: Authentication tuple from the auth dependency (used by middleware).\n\n### Raises:\n- HTTPException: with status 401 for unauthorized access.\n- HTTPException: with status 403 if permission is denied.\n- HTTPException: with status 500 and a detail object containing `response`\n and `cause` when service configuration is wrong or incomplete.\n- HTTPException: with status 503 and a detail object containing `response`\n and `cause` when unable to connect to Llama Stack.\n\n### Returns:\n - RAGListResponse: List of RAG identifiers.",
32153215
"operationId": "rags_endpoint_handler_v1_rags_get",
32163216
"responses": {
32173217
"200": {

‎docs/openapi.md‎

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Lightspeed Core Service (LCS) service - OpenAPI
1+
# Lightspeed Core Stack (LCS) service - OpenAPI
22

3-
Lightspeed Core Service (LCS) service API specification.
3+
Lightspeed Core Stack (LCS) service API specification.
44

55

66
<!-- vim-markdown-toc GFM -->
77

8-
* [🛠️ APIs](#-apis)
8+
* [🛠️ APIs](#apis)
99
* [List of REST API endpoints](#list-of-rest-api-endpoints)
1010
* [GET `/`](#get-)
1111
* [Parameters:](#parameters)
@@ -192,7 +192,6 @@ Lightspeed Core Service (LCS) service API specification.
192192
* [✅ Responses](#-responses-42)
193193
* [GET `/a2a/health`](#get-a2ahealth)
194194
* [✅ Responses](#-responses-43)
195-
* [| 200 | Successful Response | object |](#-200--successful-response--object-)
196195
* [📋 Components](#-components)
197196
* [A2AStateConfiguration](#a2astateconfiguration)
198197
* [APIKeySecurityScheme](#apikeysecurityscheme)
@@ -398,7 +397,7 @@ Lightspeed Core Service (LCS) service API specification.
398397

399398
| URL | Description |
400399
|-----|-------------|
401-
| http://localhost:8080/ | Locally running service |
400+
| http://localhost:8080 | Locally running service |
402401

403402

404403
# 🛠️ APIs
@@ -1248,13 +1247,17 @@ shields from the Llama Stack service.
12481247
- request: The incoming HTTP request (used by middleware).
12491248
- auth: Authentication tuple from the auth dependency (used by middleware).
12501249

1250+
### Raises:
1251+
- HTTPException: with status 401 for unauthorized access.
1252+
- HTTPException: with status 403 if permission is denied.
1253+
- HTTPException: with status 500 and a detail object containing `response`
1254+
and `cause` when service configuration is wrong or incomplete.
1255+
- HTTPException: with status 503 and a detail object containing `response`
1256+
and `cause` when unable to connect to Llama Stack.
1257+
12511258
### Returns:
12521259
- ShieldsResponse: An object containing the list of available shields.
12531260

1254-
### Raises:
1255-
- HTTPException: If unable to connect to the Llama Stack server or if
1256-
shield retrieval fails for any reason.
1257-
12581261

12591262

12601263

@@ -1343,15 +1346,17 @@ List all available providers grouped by API type.
13431346
- request: The incoming HTTP request.
13441347
- auth: Authentication tuple from the auth dependency.
13451348

1349+
### Raises:
1350+
- HTTPException: with status 401 for unauthorized access.
1351+
- HTTPException: with status 403 if permission is denied.
1352+
- HTTPException: with status 500 and a detail object containing `response`
1353+
and `cause` when service configuration is wrong or incomplete.
1354+
- HTTPException: with status 503 and a detail object containing `response`
1355+
and `cause` when unable to connect to Llama Stack.
1356+
13461357
### Returns:
13471358
- ProvidersListResponse: Mapping from API type to list of providers.
13481359

1349-
### Raises:
1350-
- HTTPException:
1351-
- 401: Authentication failed
1352-
- 403: Authorization failed
1353-
- 500: Lightspeed Stack configuration not loaded
1354-
- 503: Unable to connect to Llama Stack
13551360

13561361

13571362

@@ -2174,15 +2179,20 @@ Examples
21742179
21752180
List all available RAGs.
21762181

2177-
Returns:
2178-
RAGListResponse: List of RAG identifiers.
2182+
### Parameters:
2183+
- request: The incoming HTTP request (used by middleware).
2184+
- auth: Authentication tuple from the auth dependency (used by middleware).
21792185

2180-
Raises:
2181-
HTTPException:
2182-
- 401: Authentication failed
2183-
- 403: Authorization failed
2184-
- 500: Lightspeed Stack configuration not loaded
2185-
- 503: Unable to connect to Llama Stack
2186+
### Raises:
2187+
- HTTPException: with status 401 for unauthorized access.
2188+
- HTTPException: with status 403 if permission is denied.
2189+
- HTTPException: with status 500 and a detail object containing `response`
2190+
and `cause` when service configuration is wrong or incomplete.
2191+
- HTTPException: with status 503 and a detail object containing `response`
2192+
and `cause` when unable to connect to Llama Stack.
2193+
2194+
### Returns:
2195+
- RAGListResponse: List of RAG identifiers.
21862196

21872197

21882198

0 commit comments

Comments
 (0)