Do not include the default success codes to the responses if http_codes define one already

Author: anakinj

.rubocop_todo.yml

@@ -18,7 +18,7 @@ Metrics/BlockLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 275
+  Max: 280
 
 # Offense count: 12
 Metrics/CyclomaticComplexity:

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 * [#631](https://github.com/ruby-grape/grape-swagger/pull/631): Fix order of mounts with overrides - [@adie](https://github.com/adie).
 * [#267](https://github.com/ruby-grape/grape-swagger/pull/634): Fix mounting APIs in route_param namespaces - [@milgner](https://github.com/milgner), [@wojciechka](https://github.com/wojciechka).
+* [#641](https://github.com/ruby-grape/grape-swagger/pull/641): Exclude default success code if http_codes define one already - [@anakinj](https://github.com/anakinj).
 
 * Your contribution here.
 

lib/grape-swagger/endpoint.rb

@@ -191,9 +191,7 @@ def params_object(route, path)
     end
 
     def response_object(route)
-      codes = (route.http_codes || route.options[:failure] || [])
-
-      codes = apply_success_codes(route) + codes
+      codes = http_codes_from_route(route)
       codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2] } : x }
 
       codes.each_with_object({}) do |value, memo|
@@ -222,7 +220,15 @@ def response_object(route)
       end
     end
 
-    def apply_success_codes(route)
+    def http_codes_from_route(route)
+      if route.http_codes.is_a?(Array) && route.http_codes.any? { |code| code[:code].between?(200, 299) }
+        route.http_codes.clone
+      else
+        success_codes_from_route(route) + (route.http_codes || route.options[:failure] || [])
+      end
+    end
+
+    def success_codes_from_route(route)
       default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
       if @entity.is_a?(Hash)
         default_code[:code] = @entity[:code] if @entity[:code].present?

spec/swagger_v2/api_swagger_v2_status_codes_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'http status code behaivours' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  context 'when non-default success codes are deifined' do
+    let(:app) do
+      Class.new(Grape::API) do
+        desc 'Has explicit http_codes defined' do
+          http_codes [{ code: 202, message: 'We got it!' },
+                      { code: 204, message: 'Or returned no content' }]
+        end
+
+        post '/accepting_endpoint' do
+          'We got the message!'
+        end
+        add_swagger_documentation
+      end
+    end
+
+    it 'only includes the defined http_codes' do
+      expect(subject['paths']['/accepting_endpoint']['post']['responses'].keys.sort).to eq(%w[202 204].sort)
+    end
+  end
+
+  context 'when no success codes defined' do
+    let(:app) do
+      Class.new(Grape::API) do
+        desc 'Has explicit http_codes defined' do
+          http_codes [{ code: 400, message: 'Error!' },
+                      { code: 404, message: 'Not found' }]
+        end
+
+        post '/accepting_endpoint' do
+          'We got the message!'
+        end
+        add_swagger_documentation
+      end
+    end
+
+    it 'adds the success code to the response' do
+      expect(subject['paths']['/accepting_endpoint']['post']['responses'].keys.sort).to eq(%w[201 400 404].sort)
+    end
+  end
+end