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.
I found that when using body params in PUT and POST, a nested entity in the params that has a description set at the entity level will not have that description in the OpenAPI spec output. For example given:
a definition will be created (notice that the
spline
hash under properties has no description):With my fix a deep merge occurs which maintains elements on the parent object when merging a nested element: (and the
description
of "It is a spline" is kept)while looking into this I noticed that the
recursive_call
function was using theproperty
parameter as a key without regard to its format which could lead to having string and symbols mixed together specifically when nested params are being evaluated (the nested param would be the string whereas every other element would be a symbol), so I added a call to.to_sym
to ensure use of symbols throughout since we are using Hash and not HashWithIndifferentAccess.