grape-swagger 0.30.0 → 0.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 329bb3676657055c5c086902b97ce065a4b7886d9de5ea5542e7874052ab92a9
-  data.tar.gz: 4290d2ea021d4cca08b5ba4a83033fa9df8476b79cc500d9d0de9476e1190f6a
+  metadata.gz: 2cc4d92b47209a6323502fd863a738a8829e0d78b599a47e83a1aa9e52746cf7
+  data.tar.gz: cbc408aaf0f686032312bdfb3332671d73341e90eeff694162f2d0bdcfc14a81
 SHA512:
-  metadata.gz: abe0988e09f9fd987983977df65419230c04c60ef89ebb135921cf528c61c05e196873d3077db99b7540e94453929bc987e873c39f39f98adf70f77816f4fd75
-  data.tar.gz: 9530e8d9f2c2540ec167c8cbfe7a2a7775f9067ddadcca51fe7d32abee03d23a537970b4a1703b202a4d7d9c61b941fb8cb183817e9743d291e15c4c6d0db69e
+  metadata.gz: 980563a6d50454d8f7f4439b96a820423a77758ee0c20a8ea353439ddcf46a596cf2763cdd714b07530d63c71b539c50e18775aeba2639168ae0755920887dd8
+  data.tar.gz: af45e27dccdbe492ba950a6dbf29f9e3f0e4348aea8e689813cc5ed32fdd595250c2dbb689a7aa41890dcdaa33280321fb704b0e2e72975e6356631d030ae370

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 #### Features
 
+* [#686](https://github.com/ruby-grape/grape-swagger/pull/686): Allow response headers for responses with no content and for files - [@jdmurphy](https://github.com/jdmurphy).
 * Your contribution here.
 
 #### Fixes

data/lib/grape-swagger/endpoint.rb

@@ -200,6 +200,9 @@ module Grape
       codes.each_with_object({}) do |value, memo|
         value[:message] ||= ''
         memo[value[:code]] = { description: value[:message] }
+
+        memo[value[:code]][:headers] = value[:headers] if value[:headers]
+
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
         response_model = @item
@@ -217,7 +220,6 @@ module Grape
 
         memo[value[:code]][:schema] = build_reference(route, value, response_model)
         memo[value[:code]][:examples] = value[:examples] if value[:examples]
-        memo[value[:code]][:headers] = value[:headers] if value[:headers]
       end
     end
 

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '0.30.0'
+  VERSION = '0.30.1'
 end

data/spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb

@@ -18,6 +18,22 @@ describe 'response with headers' do
           { 'declared_params' => declared(params) }
         end
 
+        desc 'A 204 can have headers too' do
+          success Hash[status: 204, message: 'No content', headers: { 'Location' => { description: 'Location of resource', type: 'string' } }]
+          failure [[400, 'Bad Request', Entities::ApiError, { 'application/json' => { code: 400, message: 'Bad request' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
+        end
+        delete '/no_content_response_headers' do
+          { 'declared_params' => declared(params) }
+        end
+
+        desc 'A file can have headers too' do
+          success Hash[status: 200, model: 'File', headers: { 'Cache-Control' => { description: 'Directive for caching', type: 'string' } }]
+          failure [[404, 'NotFound', Entities::ApiError, { 'application/json' => { code: 404, message: 'Not found' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
+        end
+        get '/file_response_headers' do
+          { 'declared_params' => declared(params) }
+        end
+
         desc 'This syntax also returns headers' do
           success model: Entities::UseResponse, headers: { 'Location' => { description: 'Location of resource', type: 'string' } }
           failure [
@@ -85,6 +101,66 @@ describe 'response with headers' do
     end
   end
 
+  describe 'no content response headers' do
+    let(:header_204) do
+      { 'Location' => { 'description' => 'Location of resource', 'type' => 'string' } }
+    end
+    let(:header_400) do
+      { 'Date' => { 'description' => 'Date of failure', 'type' => 'string' } }
+    end
+    let(:examples_400) do
+      { 'application/json' => { 'code' => 400, 'message' => 'Bad request' } }
+    end
+
+    subject do
+      get '/swagger_doc/no_content_response_headers', {}
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/no_content_response_headers']['delete']).to eql(
+        'description' => 'A 204 can have headers too',
+        'produces' => ['application/json'],
+        'responses' => {
+          '204' => { 'description' => 'No content', 'headers' => header_204 },
+          '400' => { 'description' => 'Bad Request', 'headers' => header_400, 'schema' => { '$ref' => '#/definitions/ApiError' }, 'examples' => examples_400 }
+        },
+        'tags' => ['no_content_response_headers'],
+        'operationId' => 'deleteNoContentResponseHeaders'
+      )
+    end
+  end
+
+  describe 'file response headers' do
+    let(:header_200) do
+      { 'Cache-Control' => { 'description' => 'Directive for caching', 'type' => 'string' } }
+    end
+    let(:header_404) do
+      { 'Date' => { 'description' => 'Date of failure', 'type' => 'string' } }
+    end
+    let(:examples_404) do
+      { 'application/json' => { 'code' => 404, 'message' => 'Not found' } }
+    end
+
+    subject do
+      get '/swagger_doc/file_response_headers'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/file_response_headers']['get']).to eql(
+        'description' => 'A file can have headers too',
+        'produces' => ['application/json'],
+        'responses' => {
+          '200' => { 'description' => 'A file can have headers too', 'headers' => header_200, 'schema' => { 'type' => 'file' } },
+          '404' => { 'description' => 'NotFound', 'headers' => header_404, 'schema' => { '$ref' => '#/definitions/ApiError' }, 'examples' => examples_404 }
+        },
+        'tags' => ['file_response_headers'],
+        'operationId' => 'getFileResponseHeaders'
+      )
+    end
+  end
+
   describe 'response failure headers' do
     let(:header_200) do
       { 'Location' => { 'description' => 'Location of resource', 'type' => 'string' } }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.1
 platform: ruby
 authors:
 - Tim Vandecasteele