feat(zod): place null at the end when converting ZodNullable#672
Conversation
dosubot
Bot
added
the
size:XS
WalkthroughThe change updates the order of elements within the Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @soonoo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines how nullable Zod types are converted into JSON Schema. The core change reorders the anyOf array for nullable types to ensure that the non-null schema is listed before the null type. This subtle adjustment has a significant impact on how API documentation tools, such as Swagger, generate and display example values for nullable properties, making them more representative and useful by default.
Highlights
- ZodNullable Conversion Logic: I've updated the
ZodToJsonSchemaConverterto reorder theanyOfarray when convertingZodNullabletypes. Previously,nullwas placed first, but now the non-null schema is prioritized. - Improved Example Generation: This change aims to improve the default example values displayed by tools like Swagger or Scalar for nullable properties. By placing the non-null type first in the
anyOfarray, these UIs should now show a more meaningful, non-null example by default.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request modifies the order of types in the anyOf array for ZodNullable schemas, placing the JSON schema before the null type. This change aims to improve the default example displayed in UIs like Swagger or Scalar, showing a non-null value instead of null.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/hey-api
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/react
@orpc/react-query
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
soonoo
force-pushed
the
feat/zod-nullable-order
branch
from
e52f745 to
d11823b
Compare
|
|
|
I think you need to execute in the workspace level |
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
2 participants
Currently, the Zod converter transforms nullable types into schemas in the order of [null, json]. Because null appears as the first value in the array, UIs like Swagger or Scalar display null as the example value.
{ "nullableProperty": null }Although it is possible to customize the example using oz.openapi, I believe it is more reasonable to show a non-null default value as the example.
{ "nullableProperty": "non-null example" }Summary by CodeRabbit