Skip to content

docs: clarify supported zod schema features#1880

Draft
MukundaKatta wants to merge 1 commit into
openai:masterfrom
MukundaKatta:codex/document-zod-supported-features
Draft

docs: clarify supported zod schema features#1880
MukundaKatta wants to merge 1 commit into
openai:masterfrom
MukundaKatta:codex/document-zod-supported-features

Conversation

@MukundaKatta
Copy link
Copy Markdown

Summary

  • document which common Zod schema shapes work with the strict Structured Outputs subset
  • clarify that .optional() should be modeled as nullable for structured outputs
  • note that Zod runtime transforms/refinements and TypeScript comments/arbitrary metadata are not sent to the API
  • point users to .describe() / helper description for JSON Schema descriptions

Fixes #1017.

Validation

  • git diff --check

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.

clarify which zod features are supported

1 participant