feat(server, openapi): add filter option to handlers - #770
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis change introduces a unified Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Handler (RPC/OpenAPI)
participant Matcher
participant Router
User->>Handler: Initialize with { filter }
Handler->>Matcher: Pass filter option
Matcher->>Router: Traverse procedures
loop For each procedure
Matcher->>Matcher: Apply filter(procedure)
alt Filter returns true
Matcher->>Matcher: Add to matching tree
else Filter returns false
Matcher->>Matcher: Skip procedure
end
end
Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
✨ 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 @unnoq, 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 introduces a new, unified filter option across various handlers and the OpenAPI specification generator. This enhancement provides developers with more granular control over which API procedures are processed or included, replacing the less flexible exclude option and improving the overall configurability of the system.
Highlights
- Unified Filtering Option: A new
filteroption has been introduced acrossOpenAPIHandler,RPCHandler, andOpenAPIGenerator. This option provides a consistent and flexible way to programmatically control which procedures are matched by handlers or included in the generated OpenAPI specification. - Deprecation of
excludeOption: Theexcludeoption inOpenAPIGeneratorhas been deprecated. Its functionality is now subsumed by the more generalfilteroption, with backward compatibility ensured for existingexcludeimplementations. - Documentation and Test Coverage: Comprehensive documentation updates have been made for
openapi-handler,openapi-specification, andrpc-handlerto guide users on the newfilteroption. Additionally, new test cases have been added toStandardOpenAPIMatcherandStandardRPCMatcherto verify the correct behavior of the filtering logic. - Internal Matcher Integration: The
filteroption has been integrated into the coreStandardOpenAPIMatcherandStandardRPCMatcherclasses, allowing the filtering logic to be applied directly during the procedure matching process.
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. ↩
dosubot
Bot
added
the
size:L
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Code Review
This pull request introduces a filter option to OpenAPIHandler, RPCHandler, and OpenAPIGenerator to allow filtering procedures from being matched or included in the generated specification. This is a new feature that replaces the exclude option in OpenAPIGenerator, which is now deprecated with backward compatibility maintained. The implementation is consistent across packages, with updated documentation and new tests. The changes are well-structured.
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-event-iterator
@orpc/hey-api
@orpc/json-schema
@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/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
1 participant
Summary by CodeRabbit
New Features
Documentation
Tests