Add ignore_defaults option
#491
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
|
@pezholio … thanks please run |
|
Right, that should help 😄 I've also added a separate spec for the behaviour, rather than rolling it into the main |
| let(:json) { JSON.parse(last_response.body) } | ||
|
|
||
| it 'only returns one response if ignore_defaults is specified' do | ||
| expect(json['paths']['/delay_thing']['post']['responses']).to eq('202' => { 'description' => 'OK' }) |
There was a problem hiding this comment.
please add also an expectation, which proofs that the default wasn't created:
expect(json['paths']['/delay_thing']['post']['responses'].keys).not_to include '201'
|
👍 … cc/ @Bugagazavr, if you are fine with it, I'll cut the next release |
|
LGTM |
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
* Add `ignore_defaults` option * Update Changelog * Make Rubocop happy * Add seperate spec for `ignore_defaults` * Make tests more specific * Revert Rubocop-pleasing changes * Increase max line length
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.
As outlined in #490 - it seems that grape-swagger adds a default
201response forPUTandPOSTrequests. If aPUTorPOSTrequest doesn't immediately create a resource, the correct response is202 Accepted. In this case, we want to ignore the default201response, and only specify a202.There may be other use cases as well, so I've added support for an
ignore_defaultsoption which only adds user-specified responses, and ignores the default responses specified in https://github.com/ruby-grape/grape-swagger/blob/master/lib/grape-swagger/doc_methods/status_codes.rb