Allow requests with extra_params and no parameters #87
Conversation
|
I definitely want to add this, however could you add a small test to capture this? |
Without this commit, the following request:
post '/orders' do
example_request 'should take an optional parameter hash', order_type: 'big' do
...
end
end
would **not receive** the POST body/param `order_type: 'big'` specified.
The reason is that the function `params` was returning nil if
example.metadata[:parameters] was undefined, and the only one to
define example.metadata[:parameters] was to have previously called
"parameter". In other words, requests were not allowed to have so-called
"extra parameters" unless they had at least one "parameter" specified.
This commit removes this restrictions, allowing requests to specify all
their parameters "inline".
|
@oestrich I add a test that failed before my patch and passes now… is it okay? |
|
Yeah, looks good. |
…arams Allow requests with extra_params and no parameters
| @@ -52,8 +52,7 @@ def query_string | |||
| end | |||
|
|
|||
| def params | |||
| return unless example.metadata[:parameters] | |||
| parameters = example.metadata[:parameters].inject({}) do |hash, param| | |||
| parameters = example.metadata.fetch(:parameters, {}).inject({}) do |hash, param| | |||
There was a problem hiding this comment.
This seems to break if you already have set the parameters to a String (for example doing params.to_json) even when not using any extra_params
There was a problem hiding this comment.
Could you give an example of setting params to a string? I'm not sure what you mean by that. If you need to send a string you should be using raw_post
let(:raw_post) { params.to_json }There was a problem hiding this comment.
Wow I feel stupid here (facepalm) -- I was setting let(:raw_data) { params.to_json } instead of let(:raw_post) { ....}. I was getting this error doing the following:
post '/users' do
let(:raw_data) { params.to_json }
example 'creating a user' do
do_request raw_data
end
end
This causes the error where your passing do_request a string and you get an error saying inject method is not defined (which is accurate).
Without this commit, the following request:
would receive no PUT body/params, rather than the specified
concert: {year: 2011}.The reason is that the function
paramswas returning nil ifexample.metadata[:parameters]was undefined, and the only one to defineexample.metadata[:parameters]was to have previously calledparameter.In other words, requests were not allowed to have so-called "extra parameters" unless they had at least one "parameter" specified.
This commit removes this restrictions, allowing requests to specify all their parameters "inline".