Make route params a first-class endpoint input and split Route#params

[ericproulx]

Grape::Router::Route#params(input = nil) did two unrelated jobs behind one signature:

Caller	Call	Wanted
the router (router.rb)	route.params(input)	extracted param values from the matched path
grape-swagger (production)	route.params (no arg)	declared param definitions, keyed by name

One method, two consumers, two incompatible return shapes. This splits them and, along the way, lifts params out of the route_options bag.

Split

• Route#params (no arg) → the declared definitions (grape-swagger, unchanged).
• Route#params_for(input) → extracted values; router.rb calls this.

params as a first-class endpoint input

Previously params lived inside the route_options bag. Now:

• Grape::Endpoint::Options gains a :params member; Grape::Endpoint.new gains a params: keyword.
• The DSL composes params — declared params (params do … end) deep-merged with any documented alongside desc …, params: — via a prepare_params helper, and passes it as its own input.
• Endpoint#to_routes and #declared read config.params; Route receives it as a params: keyword backing #params.

The composition (declared ⊕ desc params) is preserved exactly; only its home changes. Nothing outside grape read route.options[:params] — grape-swagger gets params through the route.params method — so dropping it from the bag is safe.

Upgrading

• Grape::Router::Route#params no longer accepts an argument — use #params_for(input) to extract values from a path. The no-arg form (declared definitions) is unchanged.
• params no longer appears in route.options (nor the endpoint's route_options); it's config.params.
• Grape::Endpoint.new gains a params: keyword and Grape::Endpoint::Options a :params member.

🤖 Generated with Claude Code

[github-actions]

Danger Report

No issues found.

View run