Skip to content

Conversation

BenPope
Copy link
Member

@BenPope BenPope commented Aug 22, 2025

No description provided.

@BenPope BenPope requested a review from a team as a code owner August 22, 2025 14:53
Copy link

coderabbitai bot commented Aug 22, 2025

📝 Walkthrough

Walkthrough

The schema-registry OpenAPI spec updates adjust responses and requests to use shared definitions. GET /schemas/ids/{id} and GET /schemas/ids/{id}/versions 200 responses now reference #/definitions/schema_def instead of inline objects. POST /subjects/{subject}/versions body parameter schema_def now references #/definitions/stored_schema instead of #/definitions/schema_def. Compatibility-related definitions were augmented: get_compatibility.compatibilityLevel and put_compatibility.compatibility gained description, example, and an enum with seven allowed values (BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ 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.
    • 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.
  • 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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0e58fc4 and 2c98669.

📒 Files selected for processing (1)
  • schema-registry/schema-registry.json (3 hunks)
🔇 Additional comments (3)
schema-registry/schema-registry.json (3)

462-463: De-duplicating schema via $ref is good; adds references support

Switching the 200 response of GET /schemas/ids/{id} to #/definitions/schema_def removes inline duplication and exposes references, which aligns with richer responses in 25.2+. No functional concerns from me.

  • Ensure any examples/snippets in the docs that previously showed only schema/schemaType are updated to include optional references when present.

1554-1558: Adding enum + metadata for get_compatibility is a solid improvement

Defining explicit allowed values with description/example improves client generation and validation.

  • Confirm the server treats these values case-insensitively (many users send lowercase); if so, consider documenting that behavior in the property description.

1565-1569: Mirror enum + metadata for put_compatibility payload

Consistent constraints on the input model reduce invalid requests and improve UX in generated SDKs.

  • If the backend normalizes values (e.g., to UPPERCASE), optionally call that out in the description to set expectations for echo responses.

@kbatuigas kbatuigas self-requested a review August 22, 2025 15:00
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