Document the removal of the vestigial Endpoint Options format member#2781
Merged
Conversation
The route-metadata promotion (#2779) also dropped the always-nil `:format` member from the endpoint's internal `Options`, but that part was only noted in the commit/PR body. Record it in the CHANGELOG line and add an UPGRADING note: `Grape::Endpoint.new(format:)` now raises instead of being ignored, and `Grape::Router::Pattern#initialize` keeps `format:` as an optional keyword. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Danger ReportNo issues found. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Follow-up to #2779. That PR promoted route metadata to
Grape::Router::Routekeyword arguments and, in the same change, dropped the always-nil:formatmember from the endpoint's internalOptions. The metadata promotion was documented, but theformatremoval was only recorded in the commit/PR body — not in the CHANGELOG or UPGRADING.This adds that documentation:
Grape::Endpoint::Optionsformatmember.Grape::Endpoint.new(..., format: …)now raisesunknown keyword: :formatinstead of silently ignoring it (nothing ever passed it;config.formatwas alwaysnil, and the route's(.:format)/(.json)suffix comes fromGrape::Path).Grape::Router::Pattern#initializekeepsformat:as a now-optional keyword.Docs only — no code changes.
🤖 Generated with Claude Code