LCORE-632: updated OpenAPI docs #658
Conversation
WalkthroughRefactors OpenAPI schemas to introduce explicit Input/Output variants for authentication, authorization, JWK, and JWT configurations. Expands query models with media_type and new response fields. Updates streaming endpoint response schema/examples. Aligns markdown docs to the new schema structure and fields across openapi.json, openapi.md, and output.md. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant API as API Server
participant M as Model Engine
participant T as Tokenizer
participant Q as Quota Store
rect rgba(225,245,254,0.5)
Note over C,API: Query with optional media_type
C->>API: POST /v1/query { media_type, ... }
API->>T: Count input tokens
T-->>API: input_tokens
API->>Q: Check available_quotas
Q-->>API: quotas snapshot
API->>M: Execute query
end
alt Non-streaming
M-->>API: Response content
API-->>C: 200 QueryResponse { truncated?, input_tokens, output_tokens, available_quotas }
else Streaming (text/plain)
Note over API,C: text/plain with SSE-style lines
loop Stream chunks
M-->>API: Chunk
API-->>C: data: <chunk>\n\n
end
API->>T: Count output tokens
T-->>API: output_tokens
API-->>C: Final event/summary (tokens, truncated)
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 (3)
docs/openapi.json(13 hunks)docs/openapi.md(9 hunks)docs/output.md(9 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/openapi.md
264-264: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
265-265: Table pipe style
Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe
(MD055, table-pipe-style)
265-265: Table column count
Expected: 3; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
⏰ 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). (3)
- GitHub Check: build-pr
- GitHub Check: e2e_tests (azure)
- GitHub Check: e2e_tests (ci)
| | 200 | Streaming response with Server-Sent Events | string | ||
| string | |
There was a problem hiding this comment.
Restore the streaming response table row.
The 200-status row lost its trailing pipe and now spills onto the next line, so the Markdown table no longer renders correctly (also flagged by markdownlint MD055/MD056). Please collapse it back into a single, fully-piped row.
-| 200 | Streaming response with Server-Sent Events | string
-string |
+| 200 | Streaming response with Server-Sent Events | string (text/event-stream or text/plain) |Based on static analysis hints.
📝 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.
| | 200 | Streaming response with Server-Sent Events | string | |
| string | | |
| | 200 | Streaming response with Server-Sent Events | string (text/event-stream or text/plain) | |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
264-264: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
265-265: Table pipe style
Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe
(MD055, table-pipe-style)
265-265: Table column count
Expected: 3; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 Prompt for AI Agents
In docs/openapi.md around lines 264-265 the Markdown table row for the 200
response lost its trailing pipe and split across lines, breaking table
rendering; restore that single table row by collapsing the two lines into one
fully-piped row (ensure a trailing pipe at the end) so the row reads as a single
line like: | 200 | Streaming response with Server-Sent Events | string |.
| | 200 | Streaming response with Server-Sent Events | string | ||
| string | |
There was a problem hiding this comment.
Fix the broken streaming response table entry.
The Markdown row for the 200 response is split across two lines and missing pipes, so the table misrenders just like in openapi.md (markdownlint MD055/MD056). Please reformat it as a single row.
-| 200 | Streaming response with Server-Sent Events | string
-string |
+| 200 | Streaming response with Server-Sent Events | string (text/event-stream or text/plain) |Based on static analysis hints.
📝 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.
| | 200 | Streaming response with Server-Sent Events | string | |
| string | | |
| | 200 | Streaming response with Server-Sent Events | string (text/event-stream or text/plain) | |
🤖 Prompt for AI Agents
In docs/output.md around lines 264 to 265, the Markdown table row for the 200
response is split across two lines and missing pipe separators; merge the two
lines into a single table row and ensure it has the proper leading/trailing pipe
characters and three columns (status, description, schema) so the row renders
correctly as one line in the table.
1 participant
Description
LCORE-632: updated OpenAPI docs
Type of change
Related Tickets & Documents
Summary by CodeRabbit
New Features
Refactor
Documentation