ruby-grape / grape / 33117558998

97%

master: 97%

Pull #2862

github

Rename the desc `default` key to `default_response`

grape-swagger reads a route's default response as `route.default_response`
(GrapeSwagger::Endpoint#default_code_from_route), but grape's `desc` DSL
writes the key as `default` and never defined that reader, so the call
resolved through BaseRoute's options bag to nil. A default response
declared the way grape's README documents it was silently never
documented:

    desc('Delete a widget') { default code: 'default', message: 'boom' }
    # => route.options.keys      == [:description, :default]
    # => route.default_response  == nil

`default` was also the one name in ApiDescription::DSL_METHODS that
could not be delegated to the options bag at all, being `Hash#default`.

Rename the DSL method and the route reader to `default_response`, the
name grape-swagger already asks for, and keep `default` working as a
deprecated alias on both sides — plus the `desc 'x', default:` keyword,
which warns and is still read. The route reader accepts either key, as
`success` and `failure` do for their own two spellings.

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

1241 of 1332 branches covered (93.17%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 3 files covered. (100.0%)

3890 of 3958 relevant lines covered (98.28%)

27028.91 hits per line