Skip to content

Commit 972116f

Browse files
kzaitsevdblock
authored andcommitted
Added head method type (ruby-grape#408)
Fix: HEAD method support.
1 parent dbfa5a5 commit 972116f

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
#### Fixes
88

9+
* [#408](https://github.com/ruby-grape/grape-swagger/pull/408): fix fails when point with head method present - [@Bugagazavr](https://github.com/Bugagazavr)
910
* [#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).
1011
* [#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).
1112

lib/grape-swagger/doc_methods/status_codes.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ def get
88
post: { code: 201, message: 'created {item}' },
99
put: { code: 200, message: 'updated {item}' },
1010
patch: { code: 200, message: 'patched {item}' },
11-
delete: { code: 200, message: 'deleted {item}' }
11+
delete: { code: 200, message: 'deleted {item}' },
12+
head: { code: 200, message: 'head {item}' }
1213
}
1314
end
1415
end

spec/swagger_v2/simple_mounted_api_spec.rb

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ class SimpleMountedApi < Grape::API
2323
{ bla: 'something' }
2424
end
2525

26+
head '/simple-head-test' do
27+
status 200
28+
end
29+
2630
desc 'this gets something else',
2731
headers: {
2832
'XAuthToken' => { description: 'A required header.', required: true },
@@ -78,7 +82,7 @@ def app
7882
"swagger"=>"2.0",
7983
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
8084
"host"=>"example.org",
81-
"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"}],
85+
"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"}],
8286
"paths"=>{
8387
"/simple"=>{
8488
"get"=>{
@@ -94,6 +98,12 @@ def app
9498
"tags"=>["simple-test"],
9599
"operationId"=>"getSimpleTest",
96100
"responses"=>{"200"=>{"description"=>"This gets something for URL using - separator."}}}},
101+
"/simple-head-test"=>{
102+
"head"=>{
103+
"produces"=>["application/json"],
104+
"responses"=>{"200"=>{"description"=>"head SimpleHeadTest"}},
105+
"tags"=>["simple-head-test"],
106+
"operationId"=>"headSimpleHeadTest"}},
97107
"/simple_with_headers"=>{
98108
"get"=>{
99109
"description"=>"this gets something else",
@@ -142,7 +152,7 @@ def app
142152
"swagger"=>"2.0",
143153
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
144154
"host"=>"example.org",
145-
"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"}],
155+
"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"}],
146156
"paths"=>{
147157
"/simple"=>{
148158
"get"=>{
@@ -168,7 +178,7 @@ def app
168178
"swagger"=>"2.0",
169179
"produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
170180
"host"=>"example.org",
171-
"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"}],
181+
"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"}],
172182
"paths"=>{
173183
"/simple-test"=>{
174184
"get"=>{

0 commit comments

Comments
 (0)