Validate params only if another param is present #1047
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
| @@ -57,7 +71,7 @@ def required? | |||
| protected | |||
|
|
|||
| # Adds a parameter declaration to our list of validations. | |||
| # @param attrs [Array] (see Grape::DSL::Parameters#required) | |||
| # @param attrs [Array] (see Grape::DSL::Parameters#requires) | |||
There was a problem hiding this comment.
Thanks for fixing the comment here.
|
I think this is good enough. Swagger doesn't concern be as much, these parameters are closer to required than optional IMO. It needs CHANGELOG and README updates and I will merge. |
Usage:
# ...
params do
optional :shelf_id, type: Integer
given :shelf_id do
requires :bin_id, type: Integer
end
end
This implements ruby-grape#958. In order to achieve the DSL-style implementation,
I introduced the concept of a "lateral scope" as opposed to the
"nested scope" which `requires :foo do` opens up. A lateral scope is
subordinate to its parent, but not nested under an element.
|
Updated. I also added a test and fixed a bug where |
dblock
added a commit
that referenced
this pull request
Jun 29, 2015
Validate params only if another param is present
|
Merged, thank you. |
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.
Implements #958 (sort of). This allows for the use case where you have some parameters to an endpoint which are only relevant or meaningful if some other parameters are given. It can be used like so:
Nested use cases work, too:
One concern: This type of relationship won't show up properly in grape-swagger, or anything which looks at
Route#route_paramsto inspect parameter definitions; even though the elements in thegivenblock are actually optional unlessshelf_idis given,Route#route_paramswill indicate thatbin_idis required. I could probably get that to instead show up as optional, but I don't know if that's ideal.