docs: add docs about duplicating rules and bundle components#2812
Merged
Conversation
|
Contributor
|
Contributor
Coverage Report
File CoverageNo changed files found. |
JLekawa
approved these changes
May 14, 2026
tatomyr
reviewed
May 14, 2026
|
|
||
| The `bundle` command differs from the [`join`](./join.md) command. | ||
| The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. | ||
| The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. All components are automatically resolved and included without requiring explicit definitions. |
Collaborator
There was a problem hiding this comment.
Please use semantic breaks, at leas for the newly added text.
Contributor
Author
There was a problem hiding this comment.
Thanks, did this.
tatomyr
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why/How?
CONTRIBUTING.mdfile sentence about naming convention, when rule already exists in other specs.components.Reference
Testing
Screenshots (optional)
Check yourself
Security
Note
Low Risk
Low risk documentation-only change with no runtime code or behavior modifications.
Overview
Clarifies contributor guidance for built-in rule additions by recommending reusing existing rule names across specification flavors to keep concepts discoverable.
Updates the
bundlecommand documentation to explicitly state that referencedcomponentsare resolved and included automatically, without needing manual definitions.Reviewed by Cursor Bugbot for commit 59cacd5. Bugbot is set up for automated code reviews on this repo. Configure here.