fix(openapi): support strict object schema for dynamic params

[dinwwwh]

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of object schemas with the additionalProperties attribute, ensuring correct separation of properties while preserving the additionalProperties flag.

• Tests

  • Added a new test case to verify correct behavior when separating object schemas that include additionalProperties: true.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 1, 2025 2:01am

[coderabbitai]

Walkthrough

A new test was introduced to verify that the separateObjectSchema function correctly handles schemas with the additionalProperties attribute. The implementation of separateObjectSchema was updated so that the presence of additionalProperties no longer prevents the function from separating object schemas.

Changes

Cohort / File(s)	Change Summary
Test Addition packages/openapi/src/schema-utils.test.ts	Added a test case to validate separateObjectSchema behavior with additionalProperties: true.
Logic Update packages/openapi/src/schema-utils.ts	Modified condition to allow separation of schemas with additionalProperties without early return.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In the warren of code, a new test appears,
Ensuring that schemas can split without fears.
With additionalProperties now handled with care,
The logic is cleaner, the function more fair.
A hop and a skip, our review is through—
The code is more robust, thanks to this crew! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3beb06e and 0ab0021.

📒 Files selected for processing (2)

• packages/openapi/src/schema-utils.test.ts (1 hunks)
• packages/openapi/src/schema-utils.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/openapi/src/schema-utils.ts (1)

packages/openapi/src/schema.ts (1)

• LOGIC_KEYWORDS (21-67)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: publish-commit
• GitHub Check: lint
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

packages/openapi/src/schema-utils.ts (1)

38-38: LGTM! Well-reasoned fix for additionalProperties handling.

The exclusion of 'additionalProperties' from the early return condition is correct. Unlike other logic keywords that fundamentally alter schema behavior, additionalProperties is a constraint that can be safely preserved during schema separation, similar to how type, properties, and required are handled.

packages/openapi/src/schema-utils.test.ts (1)

81-114: Excellent test coverage for the additionalProperties fix.

The test comprehensively verifies that:

• Schemas with additionalProperties can now be separated (addressing the core issue)
• The additionalProperties attribute is correctly preserved in both matched and rest schemas
• Required property filtering works correctly (matched gets ['a'], rest gets [] since 'a' was the only required property)

The test expectations are accurate and the test structure follows the existing patterns in the file.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/openapi/spec/support-strict-object-schema-for-dynamic-params

---

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:

• 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 generate unit tests to generate unit tests for 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.

[gemini-code-assist]

Summary of Changes

Hello @unnoq, I'm Gemini Code Assist¹! 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 addresses a bug in the OpenAPI schema utility that prevented proper handling of strict object schemas, particularly when additionalProperties was defined. My changes ensure that the separateObjectSchema function correctly processes schemas with dynamic parameters, allowing for more accurate schema separation.

Highlights

• Improved Schema Separation Logic: I've updated the separateObjectSchema function to correctly recognize and handle the additionalProperties keyword. Previously, its presence could cause the function to incorrectly treat a schema as un-separable, leading to issues with strict object schemas for dynamic parameters.
• Enhanced Test Coverage: I've added a new test case to schema-utils.test.ts that specifically validates the separateObjectSchema function's behavior when a schema includes additionalProperties: true. This ensures the fix works as intended and prevents regressions.

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 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 or fill out our survey 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

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

[gemini-code-assist]

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[dinwwwh]

/gemini review

[pkg-pr-new]

More templates

• @orpc/astro-playground
• @orpc/browser-extension-playground
• @orpc/cloudflare-worker-playground
• @orpc/contract-first-playground
• @orpc/electron-playground
• @orpc/nest-playground
• @orpc/next-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground
• @orpc/tanstack-start-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@814

@orpc/client

npm i https://pkg.pr.new/@orpc/client@814

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@814

@orpc/experimental-durable-event-iterator

npm i https://pkg.pr.new/@orpc/experimental-durable-event-iterator@814

@orpc/hey-api

npm i https://pkg.pr.new/@orpc/hey-api@814

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@814

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@814

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@814

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@814

@orpc/react

npm i https://pkg.pr.new/@orpc/react@814

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@814

@orpc/server

npm i https://pkg.pr.new/@orpc/server@814

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@814

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@814

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@814

@orpc/standard-server-aws-lambda

npm i https://pkg.pr.new/@orpc/standard-server-aws-lambda@814

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@814

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@814

@orpc/standard-server-peer

npm i https://pkg.pr.new/@orpc/standard-server-peer@814

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@814

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@814

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@814

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@814

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@814

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@814

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@814

commit: 0ab0021

[gemini-code-assist]

Code Review

This pull request correctly fixes an issue with separating object schemas that include the additionalProperties attribute. The change is simple, effective, and is accompanied by a new test case that validates the fix. My review includes one suggestion to improve the code's readability and maintainability.