doc: v3.6.0 release updates

[ymc9]

Summary

• RPC OAPI generation: New docs/service/openapi/rpc.md documenting RPCApiHandler.generateSpec(), available since v3.6.0
• OpenAPI refactor: Extracted shared _openapi_spec_options.md partial to eliminate duplication between RESTful and RPC OAPI docs
• Custom types: Document relation field support in custom types (v3.6.0), including a mixin example showing shared audit fields across models; added constraint that types with relations can only be used as mixins, not for JSON fields
• Zod (PR feat(zod): enforce literal true for select/include/omit options + exclude relation fields from makeModelSchema by default + add "optionality" setting to control runtime optionality of fields zenstack#2525): Document breaking changes (makeModelSchema excludes relations by default, select/include/omit values must be true), new optionality option, and deprecation of makeModelCreateSchema/makeModelUpdateSchema
• MySQL: Remove preview feature banner

Test plan

• pnpm start — verify all updated pages render correctly
• Check docs/service/openapi/rpc.md and docs/service/openapi/restful.md both render the shared Options section via the partial
• Check docs/modeling/custom-type.md relation fields section and warning admonition render correctly
• Check docs/utilities/zod.md deprecated admonitions render correctly

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Custom types now support relation fields (available as mixins only).
  • MySQL support graduated from preview status.
  • OpenAPI spec generation now fully documented with configurable options.
  • RPC-style OpenAPI generation capabilities documented.
  • Zod utility updated: relations excluded by default; new optionality configuration option added.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
zenstack-new-site	Ready	Preview, Comment	Apr 21, 2026 0:57am

[coderabbitai]

Walkthrough

Documentation updates across modeling, databases, and services that include custom types supporting relation fields as mixins, MySQL feature status, OpenAPI specification generation configuration (refactored into a shared component), RPC-style OpenAPI generation, and revised default behavior for Zod schema generation with new optionality options.

Changes

Cohort / File(s)	Summary
Custom Type Documentation docs/modeling/custom-type.md	Added "Relation Fields" section documenting that custom types can define relation fields, with examples showing AuditMixin usage. Removed prior restriction against relation fields; custom types with relations are limited to mixin usage only.
OpenAPI Specification Components docs/service/openapi/_openapi_spec_options.md, docs/service/openapi/restful.md	Created shared OpenApiSpecOptions component documenting generateSpec options (title, version, description, summary, respectAccessPolicies) with type definitions and behavior descriptions. Refactored restful.md to reference the component instead of inline documentation; updated "Slicing" section link.
RPC-Style OpenAPI Documentation docs/service/openapi/rpc.md	Replaced placeholder content with complete documentation for RPCApiHandler.generateSpec(), including version marker (v3.6.0), shared OpenApiSpecOptions component, Express example for serving specs, and explanation of how queryOptions and omit affect generated specifications.
Database Documentation docs/recipe/databases/mysql.md	Removed <PreviewFeature /> component, reflecting MySQL support release status; installation and setup instructions remain unchanged.
Zod Utilities Documentation docs/utilities/zod.md	Updated makeModelSchema default behavior from including relations to excluding them; added optionality option with 'all' and 'defaults' modes. Marked makeModelCreateSchema and makeModelUpdateSchema as deprecated with migration guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'doc: v3.6.0 release updates' accurately summarizes the main change: documentation updates for the v3.6.0 release across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch doc/v3.6.0

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/modeling/custom-type.md`:
- Line 44: The heading "Relation Fields" is currently an h3 (###) but should be
an h2 (##) to maintain proper document hierarchy; update the markdown heading
text "Relation Fields" from "### Relation Fields" to "## Relation Fields" in the
docs/modeling/custom-type.md file so the document has correct heading levels and
consistent outline generation.

In `@docs/service/openapi/restful.md`:
- Line 84: Update the RESTful slicing description sentence that currently reads
"the spec only includes the models, operations, procedures, and filter kinds
that are allowed" by removing the word "procedures" so it lists only "models,
operations, and filter kinds"; edit the sentence in the same paragraph (the line
containing "procedures") to reflect RESTful-relevant entities and ensure
punctuation/grammar remain correct.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 498c2b77-b214-4968-aa33-463e124a44a0

📥 Commits

Reviewing files that changed from the base of the PR and between 51f95aa and d733db5.

📒 Files selected for processing (6)

• docs/modeling/custom-type.md
• docs/recipe/databases/mysql.md
• docs/service/openapi/_openapi_spec_options.md
• docs/service/openapi/restful.md
• docs/service/openapi/rpc.md
• docs/utilities/zod.md

💤 Files with no reviewable changes (1)

• docs/recipe/databases/mysql.md