Include documented Hashes #454
Merged
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
added 7 commits
June 10, 2016 14:28
|
👍 … awesome :) |
|
Excellent work @aschuster3. |
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
* Fix logic for mapping Hash and Array objects to refs * Add tests to account for documented Hashes and Arrays * Do not include readOnly params in request definitions * Test for new documentation behavior * Update changelog [ci skip] * Use respond_to? instead of try for earlier compliance * Use proper url for changelog
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 is opened to address Issue #445 and is a reopen of PR #453
Because of the way the logic is stated, raw Hashes can never be included. After digging through, I found that the reason this exists in the first place is because Hashes and Arrays are replaced with their object references when possible (e.g.
"address"=>{"$ref"=>"#/definitions/someDefinition"}is preferred over"address"=>{"type"=>"object"}).Another addition to this PR that was relevant to the original problem is that
readOnlyparameters are included in a request definition generated by the MoveParams class. Open API v2 spec says to exclude readOnly parameters in request objects and seeing as the purpose of MoveParams is to generate a helper request definition, I removed the addition of readOnly parameters. This specifically addresses redundant path parameters in the JSON block.Because the problems both of these features are closely related, I felt that the scope of this PR encompasses both changes.