LCORE-632: Update OpenAPI doc #630
Conversation
WalkthroughAdds documentation for a new GET /v1/shields endpoint to the OpenAPI docs, introducing a ShieldsResponse model with a shields array. Updates occur in docs/openapi.md and docs/output.md. No code or existing endpoint logic changes; documentation and public schema declarations are extended. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant API as API Server
participant H as Shields Handler
participant S as Shields Source
C->>API: GET /v1/shields
API->>H: Route request
H->>S: Retrieve shields
alt Success
S-->>H: Shields list
H-->>API: 200 OK (ShieldsResponse)
API-->>C: 200 OK (shields: [...])
else Connection/Retrieval Failure
H-->>API: HTTPException (500)
API-->>C: 500 Internal Server Error
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/openapi.md(2 hunks)docs/output.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/openapi.md
108-108: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
docs/output.md
108-108: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-pr
- GitHub Check: e2e_tests (ci)
| | Status Code | Description | Component | | ||
| |-------------|-------------|-----------| | ||
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | ||
| | 500 | Connection to Llama Stack is broken | | |
There was a problem hiding this comment.
Add a blank line after the responses table.
markdownlint (MD058) complains because the ### ✅ Responses table is immediately followed by the next heading. Insert a blank line after the final | 500 | … | row to keep the table surrounded by blank lines.
| 200 | Successful Response | [ShieldsResponse](#shieldsresponse) |
| 500 | Connection to Llama Stack is broken | |
+
## POST `/v1/query`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Status Code | Description | Component | | |
| |-------------|-------------|-----------| | |
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | |
| | 500 | Connection to Llama Stack is broken | | | |
| | Status Code | Description | Component | | |
| |-------------|-------------|-----------| | |
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | |
| | 500 | Connection to Llama Stack is broken | | | |
| ## POST `/v1/query` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
108-108: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In docs/openapi.md around lines 105 to 108, the responses table under "### ✅
Responses" is immediately followed by the next heading which triggers
markdownlint MD058; add a single blank line after the final table row (the line
containing "| 500 | Connection to Llama Stack is broken | |") so the table is
separated from the following heading by an empty line.
| | Status Code | Description | Component | | ||
| |-------------|-------------|-----------| | ||
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | ||
| | 500 | Connection to Llama Stack is broken | | |
There was a problem hiding this comment.
Insert a blank line after the shields responses table.
markdownlint (MD058) flags this spot because the table is not followed by a blank line before the next heading. Add an empty line after the | 500 | … | row to satisfy the rule.
| 200 | Successful Response | [ShieldsResponse](#shieldsresponse) |
| 500 | Connection to Llama Stack is broken | |
+
## POST `/v1/query`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Status Code | Description | Component | | |
| |-------------|-------------|-----------| | |
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | |
| | 500 | Connection to Llama Stack is broken | | | |
| | Status Code | Description | Component | | |
| |-------------|-------------|-----------| | |
| | 200 | Successful Response | [ShieldsResponse](#shieldsresponse) | | |
| | 500 | Connection to Llama Stack is broken | | | |
| ## POST `/v1/query` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
108-108: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In docs/output.md around lines 105 to 108, the markdown table of status codes is
not followed by a blank line which triggers markdownlint MD058; fix it by
inserting a single empty line immediately after the last table row (`| 500 |
Connection to Llama Stack is broken | |`) so the table is separated from the
following content/heading.
1 participant
Description
LCORE-632: Update OpenAPI doc
Type of change
Related Tickets & Documents
Summary by CodeRabbit