Skip to content

Conversation

tisnik
Copy link
Contributor

@tisnik tisnik commented Oct 2, 2025

Description

Update OpenAPI schema

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Summary by CodeRabbit

  • Documentation
    • Clarified root endpoint description to note it returns a static HTML index with links to Swagger UI and ReDoc.
    • Introduced a ConversationData model with conversation_id, topic_summary (nullable), and last_message_timestamp.
    • Added topic_summary to ConversationDetails and ConversationDeleteResponse.
    • Updated ConversationsListResponseV2 to return a list of ConversationData objects instead of IDs.
    • Refreshed examples and references to include topic_summary across conversations-related responses.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

Documentation 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

Cohort / File(s) Summary
Conversation schema and list response updates
docs/openapi.md, docs/output.md
Added ConversationData model (conversation_id, topic_summary, last_message_timestamp). Added topic_summary to ConversationDetails and ConversationDeleteResponse. Updated ConversationsListResponseV2 to return a list of ConversationData instead of IDs. Adjusted examples and references accordingly.
Root endpoint documentation
docs/openapi.json, docs/openapi.md
Expanded GET / description to specify static HTML index content (heading, embedded icon, links to Swagger UI and ReDoc). No functional 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
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

A nibble of docs, a hop through the schema lane,
New ConversationData sprouts after the rain.
Topic summaries bloom where IDs once grew,
The root page waves with links in view.
Thump-thump! says the rabbit—changes neat and light,
Ready to ship by moonlit night. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “Update OpenAPI schema” accurately and concisely conveys the primary purpose of the PR, which is to update and expand the OpenAPI schema and documentation. It directly reflects the main changes described.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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: Fix last_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: Correct last_message_timestamp field type

The 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: Align last_message_timestamp type with actual payload

Here 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

📥 Commits

Reviewing files that changed from the base of the PR and between 57fad78 and 39444fb.

📒 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

@tisnik tisnik merged commit ace038b into lightspeed-core:main Oct 2, 2025
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant