Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Aug 4, 2025

Description

LCORE-248: regenerated 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

Related Tickets & Documents

  • Related Issue #LCORE-248

Summary by CodeRabbit

  • Documentation
    • Updated API documentation to include a new optional attribute, no_tools, for the QueryRequest model. This attribute allows users to indicate whether to bypass all tools and MCP servers.
    • Example usage and attribute descriptions have been updated accordingly.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 4, 2025

Walkthrough

The OpenAPI documentation and schema were updated to add an optional boolean property, no_tools, to the QueryRequest model. This property indicates whether to bypass all tools and MCP servers, with a default value of false. The change is reflected in both the JSON schema and the Markdown documentation.

Changes

Cohort / File(s) Change Summary
OpenAPI Schema Update
docs/openapi.json
Added optional no_tools property (boolean or null, default: false) to QueryRequest schema and updated example.
OpenAPI Documentation Update
docs/openapi.md
Documented the new no_tools attribute in the QueryRequest model, updating attribute lists and fields table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A toggle for tools, now clear in the docs,
"No tools!" you can say, with a flip of the box.
The schema and guide, now perfectly paired,
For queries that want all their tools undeclared.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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

🧹 Nitpick comments (2)
docs/openapi.json (1)

1446-1457: Add an explicit description for the new property.

The newly-introduced no_tools property has title and default, but lacks a description at the field level. Including it improves generated client SDKs and keeps the style consistent with other optional fields (e.g. attachments, system_prompt) that also omit a description, but for a user-facing flag the intent is worth documenting locally.

   "no_tools": {
+      "description": "If true, bypass all tools and configured MCP servers.",
       "anyOf": [
         { "type": "boolean" },
         { "type": "null" }
       ],
       "title": "No Tools",
       "default": false
   },
docs/openapi.md (1)

730-747: Specify the field type in the table for no_tools.

The “Type” column is empty for the newly-added row, while other boolean fields (e.g. disable_query_system_prompt, auth_enabled) leave this blank as well, but adding boolean helps readers scanning the table.

-| no_tools |  |  |
+| no_tools | boolean |  |
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb8635c and 8055fef.

📒 Files selected for processing (2)
  • docs/openapi.json (3 hunks)
  • docs/openapi.md (2 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). (1)
  • GitHub Check: e2e_tests
🔇 Additional comments (2)
docs/openapi.json (2)

1476-1484: Model-level description update looks good.

Nice job updating the docstring to mention no_tools; this keeps the generated schema self-contained and clear.


1498-1499: Example kept in sync – LGTM

The example payload now contains "no_tools": false, mirroring the new default. ✅

@tisnik tisnik merged commit c791cd5 into lightspeed-core:main Aug 4, 2025
17 of 18 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 31, 2025
15 tasks
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