Read route metadata via readers instead of route.options[]

[ericproulx]

Consume route metadata through the route's public reader methods instead of reaching into route.options[...].

What changed

Every route.options[...] read in lib/ is replaced with the equivalent reader:

• deprecated, security, summary, detail, produces, is_array, hidden, nickname, tags → their readers
• success / failure (keyword aliases of entity / http_codes) → route.success / route.failure
• body_name → resolved by the caller as route.body_name; build_body_parameter now takes the resolved value
• the dynamic producer lookup (:formats / :content_types / :produces) → route.public_send(producer)
• grape-swagger's own :desc / :default_response → route.desc / route.default_response

There is one remaining route.options[...] read: route.options.key?(:tags) in method_object (see "Behavior note" below) — no reader distinguishes "tags absent" from "tags explicitly nil", so presence has to be checked on the raw options hash

Why

Grape is moving desc metadata toward first-class readers (as it already did for params / anchor / requirements) and wants to reserve route.options for user custom keys. Consuming routes through their method interface means grape-swagger keeps working when Grape restructures the options bag. The readers resolve on the currently-supported Grape (verified on 2.4.0).

Behavior note (detail: nil)

summary_object / description_object previously gated on route.options.key?(:detail); they now read route.detail. The only observable difference is when detail: is set explicitly to nil — it is now treated the same as an absent detail (the description holds the text and there is no separate summary), which is the more sensible reading of "no detail". Covered by a new example in api_swagger_v2_detail_spec.rb.

Behavior note (tags: nil)

Unlike detail, an explicit tags: nil is not treated as absent — it suppresses the default tag fallback (tag_object) entirely, matching the pre-migration route.options.fetch(:tags, tag_object(route, path)) behavior. This is intentionally asymmetric with detail: detail: nil reads as "no separate detail text," while tags: nil reads as "the user explicitly opted out of default tagging." Covered by the new example in endpoint_versioned_path_spec.rb.

Tests

Full suite: 515 examples, 2 failures (both pre-existing on master, unrelated to this change), 2 pending — no new failures. build_body_parameter's unit specs are updated for the value-based signature.

🤖 Generated with Claude Code

[github-actions]

Danger Report

Warnings

• Unless you're refactoring existing code or improving documentation, please update CHANGELOG.md.

Markdowns

Here's an example of a CHANGELOG.md entry:

* [#983](https://github.com/ruby-grape/grape-swagger/pull/983): Read route metadata via readers instead of route.options[] - [@ericproulx](https://github.com/ericproulx).

View run

[Copilot]

Pull request overview

This PR refactors grape-swagger’s route metadata access to use Grape’s public route reader methods (e.g., route.success, route.tags, route.body_name) instead of reaching into route.options[...], aiming to stay compatible as Grape restructures its internal options storage.

Changes:

• Updated endpoint/document generation to consume route metadata via reader methods (including dynamic producer reads via public_send).
• Updated OperationId generation to use route.nickname instead of route.options[:nickname].
• Changed build_body_parameter to accept a resolved body_name value and updated specs accordingly.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
spec/lib/move_params_spec.rb	Updates specs for the new build_body_parameter(name, body_name) signature.
lib/grape-swagger/endpoint.rb	Switches route metadata reads (tags, deprecated, security, summary/detail, produces, hidden, etc.) to reader methods.
lib/grape-swagger/doc_methods/operation_id.rb	Uses route.nickname for operationId generation.
lib/grape-swagger/doc_methods/move_params.rb	Passes route.body_name into build_body_parameter and updates its signature.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[numbata]

@ericproulx great job as usual! 👍
Let's fix the specs and merge the PR?

[ericproulx]

@ericproulx great job as usual! 👍 Let's fix the specs and merge the PR?

on it, investigating the grape HEAD issue. Merged few things today

[numbata]

I will update and merge this PR