Parameters delimited by dash cause exception #586
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
risa
changed the title
LeFnord
requested changes
Feb 27, 2017
| @@ -0,0 +1,24 @@ | |||
| require 'spec_helper' | |||
|
|
|||
| describe '#XXX nested entity given as string' do | |||
There was a problem hiding this comment.
please can you adapt the description, e.g. https://github.com/ruby-grape/grape-swagger/blob/master/spec/issues/582_file_response_spec.rb#L3 and also rename the spec file itself,
starting with issue number, thanks
There was a problem hiding this comment.
Sorry for the naming, my first PR ever ... should I open an issue for this, to get the number?
LeFnord
reviewed
Feb 27, 2017
| result | ||
| end | ||
|
|
||
| specify { expect(subject.keys).to include '/range_parameter/range/{range_start}-{range_end}' } |
There was a problem hiding this comment.
can you show the operationId, how this had changed, thanks
|
[please add changelog entry, as the bot suggest |
LeFnord
approved these changes
Feb 28, 2017
|
thanks again |
|
Thanks as well! |
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
* Fixed range parameters delimited by dash * fixed rubocop offense * updates for requested changes - renamed spec and showed operationId value in spec * Changelog updated
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.
In our project we are using api calls to return a range from array, like this:
get '/range/:range_start-:range_end'Currently this causes
NoMethodError: undefined methoddelete!' for nil:NilClass./lib/grape-swagger/doc_methods/operation_id.rb:22:in
manipulate'See the spec below for demostration.
The problem is caused by difference between regexp
/\-(\w)/and include?('-'). The path gets translated to operation: "Range_parameterRange{range_start}-{range_end}". The include?('-') matches the string but the regexp does not. And per specs the gsub! returns nil if no substitutions were made (not the least surprise principle for me).We are using only dash, possibly underscore can be offending as well, but as a first attempt I suggest only dash.
Suggestions and feedback welcome. Thanks.