-
Notifications
You must be signed in to change notification settings - Fork 45
Update OpenAPI schema #609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughDocumentation updates to OpenAPI specs and outputs: introduced a ConversationData model, added topic_summary to ConversationDetails and ConversationDeleteResponse, and changed ConversationsListResponseV2 to return ConversationData objects. Also expanded the root GET endpoint description to detail the static HTML index response. No behavioral changes indicated. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Client
participant API as Conversations API
participant Store as Conversations Store
rect rgba(230,245,255,0.6)
note over Client,API: List conversations (v2)
Client->>API: GET /v2/conversations
API->>Store: Query conversations
Store-->>API: [ {id, topic_summary?, last_message_timestamp}, ... ]
API-->>Client: 200 OK<br/>conversations: ConversationData[]
end
rect rgba(240,240,240,0.6)
note over Client,API: Root index
Client->>API: GET /
API-->>Client: 200 OK (HTML index with links)
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
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/openapi.json (1)
1441-1444
: Fixlast_message_timestamp
schema type
last_message_timestamp
is declared as a number, yet the example response (Line 748) shows an ISO-8601 string. Clients relying on this schema will expect a numeric Unix timestamp and break when they receive a string. Please update the schema to{"type": "string", "format": "date-time"}
(or adjust the example to be numeric if the API really emits numbers). Based on actual examples, the schema should be string.
🧹 Nitpick comments (2)
docs/output.md (1)
661-666
: Correctlast_message_timestamp
field typeThe table still lists
last_message_timestamp
as a number, but the API example and intended payload are ISO-8601 strings. Please update the documented type (and ideally note the date-time format) to keep the docs aligned with the schema change.docs/openapi.md (1)
661-666
: Alignlast_message_timestamp
type with actual payloadHere too, the field is described as a number, yet the API returns an ISO-8601 string. Please update the documented type/format to string (date-time) so consumers get the correct guidance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/openapi.json
(2 hunks)docs/openapi.md
(7 hunks)docs/output.md
(7 hunks)
⏰ 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
Description
Update OpenAPI schema
Type of change
Summary by CodeRabbit