[OpenAPI]: Add support for blueprinter root key#343
Open
Abishekcs wants to merge 4 commits into
Open
Conversation
…ations Add support for the `root:` option in Blueprinter parser, wrapping the schema under a named key when specified (e.g. `@response UserBlueprint(root: :user)`).
…Symbol keys in generated schema
Abishekcs
force-pushed
the
openapi/blueprinter-root-key
branch
from
b5e1f27 to
a8f4eda
Compare
Abishekcs
changed the title
Contributor
Author
|
PR is ready for review! |
rsamoilov
reviewed
Jul 1, 2026
| end | ||
| end | ||
|
|
||
| describe "collection" do |
Member
There was a problem hiding this comment.
I can see parsing fails with collections and string-based root keys, e.g. Array<UserBlueprint(root: 'user')> and Array<UserBlueprint(root: "user")>.
| RUBY | ||
| end | ||
|
|
||
| it "wraps the array items schema under the specified root key" do |
Member
There was a problem hiding this comment.
The wording seems correct, but your test looks different. The test expects a structure like [{ root_key: { ... } }], but the correct structure seems to be { root_key: [{ ... }] }.
Contributor
Author
There was a problem hiding this comment.
I thought the root key gets wrapped in array too. Didn't check the actual blueprinter output for collection, should had done that earlier😐
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
2 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 this PR does?
Add Support for
root keyExample
Screnshot