Skip to content

Commit d0c10a5

Browse files
authored
Merge pull request lightspeed-core#630 from tisnik/lcore-632-update-openapi-doc
LCORE-632: Update OpenAPI doc
2 parents da80226 + a4eeded commit d0c10a5

2 files changed

Lines changed: 74 additions & 0 deletions

File tree

docs/openapi.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,32 @@ Returns:
8080
|-------------|-------------|-----------|
8181
| 200 | Successful Response | [ModelsResponse](#modelsresponse) |
8282
| 500 | Connection to Llama Stack is broken | |
83+
## GET `/v1/shields`
84+
85+
> **Shields Endpoint Handler**
86+
87+
Handle requests to the /shields endpoint.
88+
89+
Process GET requests to the /shields endpoint, returning a list of available
90+
shields from the Llama Stack service.
91+
92+
Raises:
93+
HTTPException: If unable to connect to the Llama Stack server or if
94+
shield retrieval fails for any reason.
95+
96+
Returns:
97+
ShieldsResponse: An object containing the list of available shields.
98+
99+
100+
101+
102+
103+
### ✅ Responses
104+
105+
| Status Code | Description | Component |
106+
|-------------|-------------|-----------|
107+
| 200 | Successful Response | [ShieldsResponse](#shieldsresponse) |
108+
| 500 | Connection to Llama Stack is broken | |
83109
## POST `/v1/query`
84110

85111
> **Query Endpoint Handler**
@@ -1343,6 +1369,17 @@ Service configuration.
13431369
| cors | | |
13441370

13451371

1372+
## ShieldsResponse
1373+
1374+
1375+
Model representing a response to shields request.
1376+
1377+
1378+
| Field | Type | Description |
1379+
|-------|------|-------------|
1380+
| shields | array | List of shields available |
1381+
1382+
13461383
## StatusResponse
13471384

13481385

docs/output.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,32 @@ Returns:
8080
|-------------|-------------|-----------|
8181
| 200 | Successful Response | [ModelsResponse](#modelsresponse) |
8282
| 500 | Connection to Llama Stack is broken | |
83+
## GET `/v1/shields`
84+
85+
> **Shields Endpoint Handler**
86+
87+
Handle requests to the /shields endpoint.
88+
89+
Process GET requests to the /shields endpoint, returning a list of available
90+
shields from the Llama Stack service.
91+
92+
Raises:
93+
HTTPException: If unable to connect to the Llama Stack server or if
94+
shield retrieval fails for any reason.
95+
96+
Returns:
97+
ShieldsResponse: An object containing the list of available shields.
98+
99+
100+
101+
102+
103+
### ✅ Responses
104+
105+
| Status Code | Description | Component |
106+
|-------------|-------------|-----------|
107+
| 200 | Successful Response | [ShieldsResponse](#shieldsresponse) |
108+
| 500 | Connection to Llama Stack is broken | |
83109
## POST `/v1/query`
84110

85111
> **Query Endpoint Handler**
@@ -1343,6 +1369,17 @@ Service configuration.
13431369
| cors | | |
13441370

13451371

1372+
## ShieldsResponse
1373+
1374+
1375+
Model representing a response to shields request.
1376+
1377+
1378+
| Field | Type | Description |
1379+
|-------|------|-------------|
1380+
| shields | array | List of shields available |
1381+
1382+
13461383
## StatusResponse
13471384

13481385

0 commit comments

Comments
 (0)