Add ignore_defaults option (#491)

* Add `ignore_defaults` option

* Update Changelog

* Make Rubocop happy

* Add seperate spec for `ignore_defaults`

* Make tests more specific

* Revert Rubocop-pleasing changes

* Increase max line length

Author: pezholio

.rubocop_todo.yml

@@ -28,7 +28,7 @@ Metrics/AbcSize:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 222
+  Max: 226
 
 # Offense count: 10
 Metrics/CyclomaticComplexity:

CHANGELOG.md

@@ -3,6 +3,7 @@
 #### Features
 
 * [#486](https://github.com/ruby-grape/grape/pull/486): Use an automated PR linter, [danger.systems](http://danger.systems) - [@dblock](https://github.com/dblock).
+* [#491](https://github.com/ruby-grape/grape/pull/491): Add `ignore_defaults` option - [@pezholio](https://github.com/pezholio).
 
 * Your contribution here.
 

lib/grape-swagger/endpoint.rb

@@ -168,11 +168,9 @@ def params_object(route)
     end
 
     def response_object(route, markdown)
-      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
-      default_code[:model] = @entity if @entity
-      default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      codes = (route.http_codes || route.options[:failure] || [])
+      codes = apply_defaults(route, codes) if route.options[:ignore_defaults].nil?
 
-      codes = [default_code] + (route.http_codes || route.options[:failure] || [])
       codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2] } : x }
 
       codes.each_with_object({}) do |value, memo|
@@ -200,6 +198,13 @@ def response_object(route, markdown)
       end
     end
 
+    def apply_defaults(route, codes)
+      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
+      default_code[:model] = @entity if @entity
+      default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      [default_code] + codes
+    end
+
     def tag_object(route)
       Array(route.path.split('{')[0].split('/').reject(&:empty?).delete_if { |i| ((i == route.prefix.to_s) || (i == route.version)) }.first)
     end

spec/swagger_v2/api_swagger_v2_ignore_defaults_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'swagger spec v2.0' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      desc 'This creates Thing after a delay',
+           success: Entities::Something
+      params do
+        requires :text, type: String, documentation: { type: 'string', desc: 'Content of something.' }
+        requires :links, type: Array, documentation: { type: 'link', is_array: true }
+      end
+      post '/delay_thing', http_codes: [{ code: 202, message: 'OK' }], ignore_defaults: true do
+        status 202
+      end
+
+      version 'v3', using: :path
+      add_swagger_documentation api_version: 'v1',
+                                base_path: '/api',
+                                info: {
+                                  title: 'The API title to be displayed on the API homepage.',
+                                  description: 'A description of the API.',
+                                  contact_name: 'Contact name',
+                                  contact_email: '[email protected]',
+                                  contact_url: 'Contact URL',
+                                  license: 'The name of the license.',
+                                  license_url: 'www.The-URL-of-the-license.org',
+                                  terms_of_service_url: 'www.The-URL-of-the-terms-and-service.com'
+                                }
+    end
+  end
+
+  before do
+    get '/v3/swagger_doc'
+  end
+
+  let(:json) { JSON.parse(last_response.body) }
+
+  it 'only returns one response if ignore_defaults is specified' do
+    expect(json['paths']['/delay_thing']['post']['responses']).to eq('202' => { 'description' => 'OK' })
+    expect(json['paths']['/delay_thing']['post']['responses'].keys).not_to include '201'
+  end
+end