ruby-grape / grape / 35465618795

99%

push

github

Correct two README passages on given and on routes admitting dots (#2969)

The Dependent Parameters section tells readers to name a param renamed
with `as` by its new name in `given`, and its example does so. That was
true until 1.6.0: #2189 made renaming a `declared(params)`-only
feature, so `given` now takes the declared name and raises
Grape::Exceptions::UnknownParameter for the renamed one, as UPGRADING
for 1.6.0 and params_scope_spec record. The example raised as written.
It now names `category`, and the note says why.

The "Dots in a path segment" section says that a requirement admitting
dots claims the extension and that format-by-extension "no longer
applies to that route". The first half holds: `GET /a.b.json` hands the
endpoint "a.b.json". The second does not. The Formatter reads the
extension off the end of PATH_INFO, whatever the route captured, so the
section's own example answers `GET /a.b.json` in JSON and `GET /a.b.xml`
with a 500, the XML formatter being unable to render a String. The
behaviour is the same on 4.0.1, which shipped the sentence. The
paragraph now says so, and that declaring `format` settles the response
format whatever the extension.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

1445 of 1501 branches covered (96.27%)

Branch coverage included in aggregate %.

4301 of 4301 relevant lines covered (100.0%)

28820.69 hits per line