Skip to content

Conversation

@jeremyfiel
Copy link
Contributor

@jeremyfiel jeremyfiel commented May 22, 2025

update docs to correctly identify JSON Schema 2020-12 is the only default

fixes #4412

Summary by CodeRabbit

  • Documentation
    • Clarified which JSON Schema draft version is the default in the documentation.
  • Bug Fixes
    • Corrected the JSON Schema $schema URI formats for both "draft-2020-12" and "draft-7" outputs.
  • Tests
    • Updated test snapshots to reflect the corrected $schema URIs.

update docs to correctly identify JSON Schema 2020-12 is the only default

fixes colinhacks#4412
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 22, 2025

Walkthrough

The updates correct the JSON Schema $schema URI for both draft-2020-12 and draft-7 targets in code and test snapshots, and clarify the documentation to indicate the proper default. Only string values and comments are adjusted, with no changes to logic or exported APIs.

Changes

File(s) Change Summary
packages/docs/content/json-schema.mdx Updated documentation to clarify only "draft-2020-12" is the default target; "draft-7" is no longer marked as default.
packages/zod/src/v4/classic/tests/json-schema.test.ts Updated all test snapshots to use corrected $schema URLs for draft-2020-12 and draft-7.
packages/zod/src/v4/core/to-json-schema.ts Fixed $schema URI assignment for both draft-2020-12 (slash instead of hyphen) and draft-7 (HTTP and trailing #).

Assessment against linked issues

Objective Addressed Explanation
Correct the default $schema identifier for JSON Schema draft-07 (#4412)

Possibly related PRs

Poem

A slash for the draft, a hash for the seven,
Schema URLs now point straight to JSON heaven.
Docs are precise, and tests all align,
With each little fix, the schemas refine.
Code and comments, in harmony dwell—
All’s well in the land where the schemas compel!
🚀

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a2c9892 and abce737.

📒 Files selected for processing (3)
  • packages/docs/content/json-schema.mdx (1 hunks)
  • packages/zod/src/v4/classic/tests/json-schema.test.ts (61 hunks)
  • packages/zod/src/v4/core/to-json-schema.ts (1 hunks)
🔇 Additional comments (4)
packages/zod/src/v4/core/to-json-schema.ts (2)

722-722: Corrected Draft-2020-12 $schema URI
The $schema URI now follows the official spec’s https://json-schema.org/draft/2020-12/schema. Nice catch!


724-724: Verify Draft-7 $schema URI scheme
This change uses http://json-schema.org/draft-07/schema#. The official docs often reference https://json-schema.org/draft-07/schema#. Could you confirm that the http scheme and trailing # are intentional?

packages/zod/src/v4/classic/tests/json-schema.test.ts (1)

9-246: Snapshots updated to new $schema URI
All inline snapshots have been refreshed to the corrected https://json-schema.org/draft/2020-12/schema. The rest of the schema output remains unchanged and tests are valid.

packages/docs/content/json-schema.mdx (1)

145-145: Clarified default target version
The documentation now clearly marks Draft 2020-12 as the default and lists Draft-7 as an alternative. This aligns nicely with the implementation.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

@EDM115
Copy link

EDM115 commented May 22, 2025

Thanks Jeremy 🎉

@colinhacks colinhacks merged commit 2529f82 into colinhacks:main May 22, 2025
5 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.

Incorrect default $schema identifier for JSON Schema draft-07

3 participants