fix: enable swagger generator to add referenced schema for an array of hashes param #689
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.
Context
Currently, the swagger generator produces a schema that uses
{type: "string"}
for anyparam
that is specified as an Array, even when theparam
is actually an Array of Hashes.Example:
Currently, the following annotation for a
param
...would get rendered in a schema as:
(note that the nested parameters for the Array are completely missing in the rendered schema)
Solution
The following fix looks into the
param_desc
to verify whether the param is a Hash, and if so, attempts to generate a referenced schema for its parameters.The name of the reference is derived in a similar fashion to the naming for an operation id using the
swagger_op_id_for_path
as seen here, but the name is suffixed with_param_[name of the param]