docs: add description for new plugin option "includeOpenApiIgnored"

[lenageorgescu-dsl]

Updating the docs of @zenstackhq/openapi following this PR:
zenstackhq/zenstack#2221

It describes the usage of the new plugin option "includeOpenApiIgnored".

Summary by CodeRabbit

• Documentation
  • Added documentation for a new OpenAPI plugin option includeOpenApiIgnored (Boolean, default false) to control inclusion of models tagged with @@openapi.ignore.
  • Clarified that ignored models are excluded by default and how enabling includeOpenApiIgnored includes them.
  • Provided guidance and concrete examples for generating two OpenAPI specs (public and internal) by configuring the plugin twice with different outputs, mirrored under the @@openapi.ignore section.

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
zenstack-new-site	Ready	Preview	Comment	Aug 16, 2025 2:53pm

[coderabbitai]

Walkthrough

Adds a new OpenAPI plugin option includeOpenApiIgnored (default false), clarifies that models tagged @@openapi.ignore are excluded by default, and adds examples and guidance for producing two specs (public and internal) by configuring the plugin twice. Documentation-only; no code or API changes.

Changes

Cohort / File(s)	Summary of Changes
Docs: OpenAPI plugin docs/reference/plugins/openapi.mdx	Added includeOpenApiIgnored option to Options table (default false); clarified default exclusion of @@openapi.ignore models; documented dual-spec workflow with two plugin configurations and outputs (./openapi-public.yaml and ./openapi-internal.yaml); added concrete examples and mirrored guidance under the @@openapi.ignore section; retained existing example adjusted to the new context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

[coderabbitai]

Actionable comments posted: 2

📜 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 993a1c3 and d113829.

📒 Files selected for processing (1)

• docs/reference/plugins/openapi.mdx (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/reference/plugins/openapi.mdx

[grammar] ~29-~29: There might be a mistake here.
Context: .... | No | false | | omitInputDetails | Boolean | **Only va...

(QB_NEW_EN)

🔇 Additional comments (1)

docs/reference/plugins/openapi.mdx (1)

183-185: Clear and helpful explanation of default behavior and dual-spec use case

The added context around default exclusion and when to set includeOpenApiIgnored is concise and useful.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/reference/plugins/openapi.mdx (1)

2-2: Minor wording tweak: align “OpenAPI 3.0” with 3.1 usage elsewhere

Front matter says “OpenAPI 3.0” while the default specVersion is 3.1.0 and the link points to 3.1. Suggest making it version-agnostic.

Apply this diff:

-description: Plugin for generating OpenAPI 3.0 specifications
+description: Plugin for generating OpenAPI 3.x specifications

📜 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 d113829 and abb6bb4.

📒 Files selected for processing (1)

• docs/reference/plugins/openapi.mdx (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/reference/plugins/openapi.mdx

[grammar] ~29-~29: There might be a mistake here.
Context: .... | No | false | | omitInputDetails | Boolean | **Only va...

(QB_NEW_EN)

🔇 Additional comments (2)

docs/reference/plugins/openapi.mdx (2)

29-29: Option description correctly references @@openapi.ignore

Good fix aligning the option description with the actual attribute syntax.

---

183-199: Great clarification and example; distinct plugin block names are spot-on

Clear explanation of dual-spec generation and using unique block names (openapiPublic/openapiInternal). This avoids collisions and makes the config self-explanatory.