Skip to content

Added head method type #408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2016
Merged

Added head method type #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62f61d5
Added head method type
kzaitsev May 6, 2016
bf4b00c
Added spec and changelog
kzaitsev May 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

#### Fixes

* [#408](https://github.com/ruby-grape/grape-swagger/pull/408): fix fails when point with head method present - [@Bugagazavr](https://github.com/Bugagazavr)
* [#405](https://github.com/ruby-grape/grape-swagger/pull/405): corrects documentation of versions [issue #403](https://github.com/ruby-grape/grape-swagger/issues/403) - [@LeFnord](https://github.com/LeFnord).
* [#399](https://github.com/ruby-grape/grape-swagger/pull/399): makes param description optional, solves [issue #395](https://github.com/ruby-grape/grape-swagger/issues/395) - [@LeFnord](https://github.com/LeFnord).

Expand Down
3 changes: 2 additions & 1 deletion lib/grape-swagger/doc_methods/status_codes.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ def get
post: { code: 201, message: 'created {item}' },
put: { code: 200, message: 'updated {item}' },
patch: { code: 200, message: 'patched {item}' },
delete: { code: 200, message: 'deleted {item}' }
delete: { code: 200, message: 'deleted {item}' },
head: { code: 200, message: 'head {item}' }
}
end
end
Expand Down
16 changes: 13 additions & 3 deletions spec/swagger_v2/simple_mounted_api_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ class SimpleMountedApi < Grape::API
{ bla: 'something' }
end

head '/simple-head-test' do
status 200
end

desc 'this gets something else',
headers: {
'XAuthToken' => { description: 'A required header.', required: true },
Expand Down Expand Up @@ -78,7 +82,7 @@ def app
"swagger"=>"2.0",
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
"host"=>"example.org",
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple-head-test", "description"=>"Operations about simple-head-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"paths"=>{
"/simple"=>{
"get"=>{
Expand All @@ -94,6 +98,12 @@ def app
"tags"=>["simple-test"],
"operationId"=>"getSimpleTest",
"responses"=>{"200"=>{"description"=>"This gets something for URL using - separator."}}}},
"/simple-head-test"=>{
"head"=>{
"produces"=>["application/json"],
"responses"=>{"200"=>{"description"=>"head SimpleHeadTest"}},
"tags"=>["simple-head-test"],
"operationId"=>"headSimpleHeadTest"}},
"/simple_with_headers"=>{
"get"=>{
"description"=>"this gets something else",
Expand Down Expand Up @@ -142,7 +152,7 @@ def app
"swagger"=>"2.0",
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
"host"=>"example.org",
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple-head-test", "description"=>"Operations about simple-head-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"paths"=>{
"/simple"=>{
"get"=>{
Expand All @@ -168,7 +178,7 @@ def app
"swagger"=>"2.0",
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
"host"=>"example.org",
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple-head-test", "description"=>"Operations about simple-head-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
"paths"=>{
"/simple-test"=>{
"get"=>{
Expand Down