explicit kwargs for namespace and route_param #2647
+20
−21
Conversation
This file contains hidden or 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
ericproulx
force-pushed
the
namespace_route_param_explicit_kwargs
branch
from
b9c8f54 to
035f3ef
Compare
dblock
requested changes
Dec 22, 2025
Member
dblock
left a comment
dblock
left a comment
There was a problem hiding this comment.
Fixup spelling in UPGRADING + some questions/rebase please?
| param.to_sym => options[:requirements] | ||
| } if options[:requirements].is_a?(Regexp) | ||
| def route_param(param, requirements: nil, type: nil, **options, &block) | ||
| requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp) |
Member
There was a problem hiding this comment.
Suggested change
| requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp) | |
| requirements = { param.to_sym => requirements } if requirements&.is_a?(Regexp) |
Nit, but that avoids calling is_a?(nil)?
|
|
||
| #### Explicit kwargs for `namespace` and `route_param` | ||
|
|
||
| `namespace` and `route_param` are now now defined with a `**options` instead of `options = {}`. In addtion, `requirements` in explicitely defined so its not in `options` anymore. You can still call `requirements` like before but `options[:requirements]` will be empty. For `route_param`, `type` is also an explicit parameter so it's not in `options` anymore. See [#2647](https://github.com/ruby-grape/grape/pull/2647) for more information. |
Member
There was a problem hiding this comment.
Suggested change
| `namespace` and `route_param` are now now defined with a `**options` instead of `options = {}`. In addtion, `requirements` in explicitely defined so its not in `options` anymore. You can still call `requirements` like before but `options[:requirements]` will be empty. For `route_param`, `type` is also an explicit parameter so it's not in `options` anymore. See [#2647](https://github.com/ruby-grape/grape/pull/2647) for more information. | |
| The `API#namespace` and `route_param` methods are now defined with `**options` instead of `options = {}`. In addtion, `requirements` in explicitly defined so it's not in `options` anymore. You can still call `requirements` like before but `options[:requirements]` will be empty. For `route_param`, `type` is also an explicit parameter so it's not in `options` anymore. See [#2647](https://github.com/ruby-grape/grape/pull/2647) for more information. |
Member
There was a problem hiding this comment.
Is this part of an API change/breaking change?
Does this need a before/after with an example of how to call it?
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 PR replaces
options = {}to modern**optionswith explicit optional parametersrequirementsandtype.