Fix params extension does not work when param_type is body #918
Conversation
This file contains 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
numbata
changed the title
numbata
force-pushed
the
add_extension_properties_to_schema
branch
from
8e222eb
to
57339b6
Compare
|
@LeFnord do you have an estimate for the next release? |
|
@mscrivo maybe you knows something about next release? 🥺 |
|
no hurry … I'm on |
|
done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request resolves issue #901 by implementing the
add_extension_propertiesmethod inMoveParams. The issue caused custom extension properties in body parameters to be excluded from the generated Swagger documentation.This new method ensures that any key/value pairs prefixed with 'x-' in the schema definition of the body parameter are correctly processed and included in the Swagger output. The processing of parameters in both
MoveParamsandParseParamshas been updated to use this new functionality.These changes ensure that custom extensions, such as
x: { some: 'stuff' }, are accurately documented in the Swagger output, resulting in comprehensive and precise API documentation.A new test case has also been added to verify the accurate reflection of custom extension properties in the Swagger documentation. The test case can be found at
spec/issues/901_extensions_on_body_params_spec.rb.