Don't overwrite model description with the route destription.

Bhacaz · Bhacaz · commit c6cef6a4a9db · 2020-09-03T10:25:26.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@
 #### Fixes
 
 * Your contribution here.
-
+* [#804](https://github.com/ruby-grape/grape-swagger/pull/804): Don't overwrite model description with the route description. - [@Bhacaz](https://github.com/Bhacaz)
 
 ### 1.2.1 (July 15, 2020)
 
diff --git a/README.md b/README.md
@@ -859,10 +859,11 @@ get '/thing', failure: [
 end
 ```
 
-By adding a `model` key, e.g. this would be taken.
+By adding a `model` key, e.g. this would be taken. Setting an empty string will act like an empty body.
 ```ruby
 get '/thing', failure: [
   { code: 400, message: 'General error' },
+  { code: 403, message: 'Forbidden error', model: '' },
   { code: 422, message: 'Invalid parameter entry', model: Entities::ApiError }
 ] do
   # ...
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -1,5 +1,9 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 1.3.0
+
+- The model (entity) description no longer comes from the route description. It will have a default value: `<<EntityName>> model`.
+
 ### Upgrading to >= 1.2.0
 
 - The entity_name class method is now called on parent classes for inherited entities. Now you can do this
diff --git a/lib/grape-swagger/endpoint.rb b/lib/grape-swagger/endpoint.rb
@@ -78,11 +78,11 @@ def contact_object(infos)
     def path_and_definition_objects(namespace_routes, options)
       @paths = {}
       @definitions = {}
+      add_definitions_from options[:models]
       namespace_routes.each_value do |routes|
         path_item(routes, options)
       end
 
-      add_definitions_from options[:models]
       [@paths, @definitions]
     end
 
@@ -207,19 +207,22 @@ def response_object(route, options)
 
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
-        response_model = @item
-        response_model = expose_params_from_model(value[:model]) if value[:model]
-
         if memo.key?(200) && route.request_method == 'DELETE' && value[:model].nil?
           memo[204] = memo.delete(200)
           value[:code] = 204
         end
 
         next if value[:code] == 204
-        next unless !response_model.start_with?('Swagger_doc') && (@definitions[response_model] || value[:model])
+        # Explicitly request no model with { model: '' }
+        next if value[:model] == ''
+
+        response_model = @item
+        response_model = expose_params_from_model(value[:model]) if value[:model]
 
-        @definitions[response_model][:description] = description_object(route)
+        next unless @definitions[response_model]
+        next if response_model.start_with?('Swagger_doc')
 
+        @definitions[response_model][:description] ||= "#{response_model} model"
         memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
         memo[value[:code]][:examples] = value[:examples] if value[:examples]
       end
diff --git a/spec/support/model_parsers/entity_parser.rb b/spec/support/model_parsers/entity_parser.rb
@@ -145,23 +145,23 @@ class DocumentedHashAndArrayModel < Grape::Entity
 
   let(:swagger_nested_type) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },
-      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'This returns something' }
+      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'UseItemResponseAsType model' }
     }
   end
 
   let(:swagger_entity_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },
-      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'This returns something' }
+      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'UseResponse model' }
     }
   end
 
   let(:swagger_params_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' }
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' }
     }
   end
 
@@ -300,7 +300,7 @@ class DocumentedHashAndArrayModel < Grape::Entity
           'type' => 'object',
           'required' => ['elements'],
           'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },
-          'description' => 'nested route inside namespace'
+          'description' => 'QueryInput model'
         },
         'QueryInputElement' => {
           'type' => 'object',
@@ -310,7 +310,7 @@ class DocumentedHashAndArrayModel < Grape::Entity
         'ApiError' => {
           'type' => 'object',
           'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } },
-          'description' => 'This gets Things.'
+          'description' => 'ApiError model'
         },
         'Something' => {
           'type' => 'object',
@@ -320,7 +320,7 @@ class DocumentedHashAndArrayModel < Grape::Entity
             'links' => { 'type' => 'array', 'items' => { 'type' => 'link' } },
             'others' => { 'type' => 'text' }
           },
-          'description' => 'This gets Things.'
+          'description' => 'Something model'
         }
       }
     }
diff --git a/spec/support/model_parsers/mock_parser.rb b/spec/support/model_parsers/mock_parser.rb
@@ -112,7 +112,7 @@ class ApiResponse < OpenStruct; end
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       },
       'UseItemResponseAsType' => {
         'type' => 'object',
@@ -122,7 +122,7 @@ class ApiResponse < OpenStruct; end
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'UseItemResponseAsType model'
       }
     }
   end
@@ -137,7 +137,7 @@ class ApiResponse < OpenStruct; end
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'UseResponse model'
       },
       'ApiError' => {
         'type' => 'object',
@@ -147,7 +147,7 @@ class ApiResponse < OpenStruct; end
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       }
     }
   end
@@ -162,7 +162,7 @@ class ApiResponse < OpenStruct; end
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       }
     }
   end
@@ -296,7 +296,7 @@ class ApiResponse < OpenStruct; end
               'description' => "it's a mock"
             }
           },
-          'description' => 'nested route inside namespace'
+          'description' => 'QueryInput model'
         },
         'ApiError' => {
           'type' => 'object',
@@ -306,7 +306,7 @@ class ApiResponse < OpenStruct; end
               'description' => "it's a mock"
             }
           },
-          'description' => 'This gets Things.'
+          'description' => 'ApiError model'
         },
         'Something' => {
           'type' => 'object',
@@ -316,7 +316,7 @@ class ApiResponse < OpenStruct; end
               'description' => "it's a mock"
             }
           },
-          'description' => 'This gets Things.'
+          'description' => 'Something model'
         }
       }
     }
diff --git a/spec/support/model_parsers/representable_parser.rb b/spec/support/model_parsers/representable_parser.rb
@@ -218,22 +218,22 @@ class DocumentedHashAndArrayModel < Representable::Decorator
 
   let(:swagger_nested_type) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' },
-      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, 'responses' => { 'description' => '', 'type' => 'ResponseItem' } }, 'description' => 'This returns something' }
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' },
+      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, 'responses' => { 'description' => '', 'type' => 'ResponseItem' } }, 'description' => 'UseItemResponseAsType model' }
     }
   end
 
   let(:swagger_entity_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' },
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'description' => '', 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'description' => '', 'type' => 'string' } } },
-      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' }, 'description' => '' } }, 'description' => 'This returns something' }
+      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' }, 'description' => '' } }, 'description' => 'UseResponse model' }
     }
   end
 
   let(:swagger_params_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' }
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' }
     }
   end
 
@@ -372,7 +372,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator
           'type' => 'object',
           'required' => ['elements'],
           'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },
-          'description' => 'nested route inside namespace'
+          'description' => 'QueryInput model'
         },
         'QueryInputElement' => {
           'type' => 'object',
@@ -382,7 +382,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator
         'ApiError' => {
           'type' => 'object',
           'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } },
-          'description' => 'This gets Things.'
+          'description' => 'ApiError model'
         },
         'Something' => {
           'type' => 'object',
@@ -392,7 +392,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator
             'links' => { 'type' => 'array', 'items' => { 'description' => '', 'type' => 'link' } },
             'others' => { 'description' => '', 'type' => 'text' }
           },
-          'description' => 'This gets Things.'
+          'description' => 'Something model'
         }
       }
     }
diff --git a/spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb b/spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'response' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  before :all do
+    module TheApi
+      class ResponseApiModels < Grape::API
+        format :json
+
+        desc 'This returns something',
+             success: [{ code: 200 }],
+             failure: [
+               { code: 400, message: 'NotFound', model: '' },
+               { code: 404, message: 'BadRequest', model: Entities::ApiError }
+             ]
+        get '/use-response' do
+          { 'declared_params' => declared(params) }
+        end
+
+        add_swagger_documentation(models: [Entities::UseResponse])
+      end
+    end
+  end
+
+  def app
+    TheApi::ResponseApiModels
+  end
+
+  describe 'uses entity as response object implicitly with route name' do
+    subject do
+      get '/swagger_doc/use-response'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/use-response']['get']).to eql(
+        'description' => 'This returns something',
+        'produces' => ['application/json'],
+        'responses' => {
+          '200' => { 'description' => 'This returns something', 'schema' => { '$ref' => '#/definitions/UseResponse' } },
+          '400' => { 'description' => 'NotFound' },
+          '404' => { 'description' => 'BadRequest', 'schema' => { '$ref' => '#/definitions/ApiError' } }
+        },
+        'tags' => ['use-response'],
+        'operationId' => 'getUseResponse'
+      )
+      expect(subject['definitions']).to eql(swagger_entity_as_response_object)
+    end
+  end
+end
diff --git a/spec/swagger_v2/reference_entity_spec.rb b/spec/swagger_v2/reference_entity_spec.rb
@@ -103,7 +103,7 @@ def app
             'description' => 'Something interesting.'
           }
         },
-        'description' => 'This returns kind and something or an error'
+        'description' => 'KindCustom model'
       )
     end
   end
@@ -122,7 +122,7 @@ def app
           'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },
           'child' => { 'type' => 'string', 'description' => 'Child property.' }
         },
-        'description' => 'This returns a child entity'
+        'description' => 'MyAPI::Child model'
       )
     end
   end

Original file line number	Diff line number	Diff line change
`@@ -145,23 +145,23 @@ class DocumentedHashAndArrayModel < Grape::Entity`
`145`	`145`
`146`	`146`	`let(:swagger_nested_type) do`
`147`	`147`	`{`
`148`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },`
	`148`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },`
`149`	`149`	`'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },`
`150`		`- 'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'This returns something' }`
	`150`	`+ 'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'UseItemResponseAsType model' }`
`151`	`151`	`}`
`152`	`152`	`end`
`153`	`153`
`154`	`154`	`let(:swagger_entity_as_response_object) do`
`155`	`155`	`{`
`156`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },`
	`156`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },`
`157`	`157`	`'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },`
`158`		`- 'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'This returns something' }`
	`158`	`+ 'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'UseResponse model' }`
`159`	`159`	`}`
`160`	`160`	`end`
`161`	`161`
`162`	`162`	`let(:swagger_params_as_response_object) do`
`163`	`163`	`{`
`164`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' }`
	`164`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' }`
`165`	`165`	`}`
`166`	`166`	`end`
`167`	`167`
`@@ -300,7 +300,7 @@ class DocumentedHashAndArrayModel < Grape::Entity`
`300`	`300`	`'type' => 'object',`
`301`	`301`	`'required' => ['elements'],`
`302`	`302`	`'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },`
`303`		`- 'description' => 'nested route inside namespace'`
	`303`	`+ 'description' => 'QueryInput model'`
`304`	`304`	`},`
`305`	`305`	`'QueryInputElement' => {`
`306`	`306`	`'type' => 'object',`
`@@ -310,7 +310,7 @@ class DocumentedHashAndArrayModel < Grape::Entity`
`310`	`310`	`'ApiError' => {`
`311`	`311`	`'type' => 'object',`
`312`	`312`	`'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } },`
`313`		`- 'description' => 'This gets Things.'`
	`313`	`+ 'description' => 'ApiError model'`
`314`	`314`	`},`
`315`	`315`	`'Something' => {`
`316`	`316`	`'type' => 'object',`
`@@ -320,7 +320,7 @@ class DocumentedHashAndArrayModel < Grape::Entity`
`320`	`320`	`'links' => { 'type' => 'array', 'items' => { 'type' => 'link' } },`
`321`	`321`	`'others' => { 'type' => 'text' }`
`322`	`322`	`},`
`323`		`- 'description' => 'This gets Things.'`
	`323`	`+ 'description' => 'Something model'`
`324`	`324`	`}`
`325`	`325`	`}`
`326`	`326`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ class ApiResponse < OpenStruct; end`
`112`	`112`	`'description' => "it's a mock"`
`113`	`113`	`}`
`114`	`114`	`},`
`115`		`- 'description' => 'This returns something'`
	`115`	`+ 'description' => 'ApiError model'`
`116`	`116`	`},`
`117`	`117`	`'UseItemResponseAsType' => {`
`118`	`118`	`'type' => 'object',`
`@@ -122,7 +122,7 @@ class ApiResponse < OpenStruct; end`
`122`	`122`	`'description' => "it's a mock"`
`123`	`123`	`}`
`124`	`124`	`},`
`125`		`- 'description' => 'This returns something'`
	`125`	`+ 'description' => 'UseItemResponseAsType model'`
`126`	`126`	`}`
`127`	`127`	`}`
`128`	`128`	`end`
`@@ -137,7 +137,7 @@ class ApiResponse < OpenStruct; end`
`137`	`137`	`'description' => "it's a mock"`
`138`	`138`	`}`
`139`	`139`	`},`
`140`		`- 'description' => 'This returns something'`
	`140`	`+ 'description' => 'UseResponse model'`
`141`	`141`	`},`
`142`	`142`	`'ApiError' => {`
`143`	`143`	`'type' => 'object',`
`@@ -147,7 +147,7 @@ class ApiResponse < OpenStruct; end`
`147`	`147`	`'description' => "it's a mock"`
`148`	`148`	`}`
`149`	`149`	`},`
`150`		`- 'description' => 'This returns something'`
	`150`	`+ 'description' => 'ApiError model'`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`	`end`
`@@ -162,7 +162,7 @@ class ApiResponse < OpenStruct; end`
`162`	`162`	`'description' => "it's a mock"`
`163`	`163`	`}`
`164`	`164`	`},`
`165`		`- 'description' => 'This returns something'`
	`165`	`+ 'description' => 'ApiError model'`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`	`end`
`@@ -296,7 +296,7 @@ class ApiResponse < OpenStruct; end`
`296`	`296`	`'description' => "it's a mock"`
`297`	`297`	`}`
`298`	`298`	`},`
`299`		`- 'description' => 'nested route inside namespace'`
	`299`	`+ 'description' => 'QueryInput model'`
`300`	`300`	`},`
`301`	`301`	`'ApiError' => {`
`302`	`302`	`'type' => 'object',`
`@@ -306,7 +306,7 @@ class ApiResponse < OpenStruct; end`
`306`	`306`	`'description' => "it's a mock"`
`307`	`307`	`}`
`308`	`308`	`},`
`309`		`- 'description' => 'This gets Things.'`
	`309`	`+ 'description' => 'ApiError model'`
`310`	`310`	`},`
`311`	`311`	`'Something' => {`
`312`	`312`	`'type' => 'object',`
`@@ -316,7 +316,7 @@ class ApiResponse < OpenStruct; end`
`316`	`316`	`'description' => "it's a mock"`
`317`	`317`	`}`
`318`	`318`	`},`
`319`		`- 'description' => 'This gets Things.'`
	`319`	`+ 'description' => 'Something model'`
`320`	`320`	`}`
`321`	`321`	`}`
`322`	`322`	`}`
Original file line number	Diff line number	Diff line change
`@@ -218,22 +218,22 @@ class DocumentedHashAndArrayModel < Representable::Decorator`
`218`	`218`
`219`	`219`	`let(:swagger_nested_type) do`
`220`	`220`	`{`
`221`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' },`
`222`		`- 'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, 'responses' => { 'description' => '', 'type' => 'ResponseItem' } }, 'description' => 'This returns something' }`
	`221`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' },`
	`222`	`+ 'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, 'responses' => { 'description' => '', 'type' => 'ResponseItem' } }, 'description' => 'UseItemResponseAsType model' }`
`223`	`223`	`}`
`224`	`224`	`end`
`225`	`225`
`226`	`226`	`let(:swagger_entity_as_response_object) do`
`227`	`227`	`{`
`228`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' },`
	`228`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' },`
`229`	`229`	`'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'description' => '', 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'description' => '', 'type' => 'string' } } },`
`230`		`- 'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' }, 'description' => '' } }, 'description' => 'This returns something' }`
	`230`	`+ 'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'description' => '', 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' }, 'description' => '' } }, 'description' => 'UseResponse model' }`
`231`	`231`	`}`
`232`	`232`	`end`
`233`	`233`
`234`	`234`	`let(:swagger_params_as_response_object) do`
`235`	`235`	`{`
`236`		`- 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' }`
	`236`	`+ 'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' }`
`237`	`237`	`}`
`238`	`238`	`end`
`239`	`239`
`@@ -372,7 +372,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator`
`372`	`372`	`'type' => 'object',`
`373`	`373`	`'required' => ['elements'],`
`374`	`374`	`'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },`
`375`		`- 'description' => 'nested route inside namespace'`
	`375`	`+ 'description' => 'QueryInput model'`
`376`	`376`	`},`
`377`	`377`	`'QueryInputElement' => {`
`378`	`378`	`'type' => 'object',`
`@@ -382,7 +382,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator`
`382`	`382`	`'ApiError' => {`
`383`	`383`	`'type' => 'object',`
`384`	`384`	`'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } },`
`385`		`- 'description' => 'This gets Things.'`
	`385`	`+ 'description' => 'ApiError model'`
`386`	`386`	`},`
`387`	`387`	`'Something' => {`
`388`	`388`	`'type' => 'object',`
`@@ -392,7 +392,7 @@ class DocumentedHashAndArrayModel < Representable::Decorator`
`392`	`392`	`'links' => { 'type' => 'array', 'items' => { 'description' => '', 'type' => 'link' } },`
`393`	`393`	`'others' => { 'description' => '', 'type' => 'text' }`
`394`	`394`	`},`
`395`		`- 'description' => 'This gets Things.'`
	`395`	`+ 'description' => 'Something model'`
`396`	`396`	`}`
`397`	`397`	`}`
`398`	`398`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ def app`
`103`	`103`	`'description' => 'Something interesting.'`
`104`	`104`	`}`
`105`	`105`	`},`
`106`		`- 'description' => 'This returns kind and something or an error'`
	`106`	`+ 'description' => 'KindCustom model'`
`107`	`107`	`)`
`108`	`108`	`end`
`109`	`109`	`end`
`@@ -122,7 +122,7 @@ def app`
`122`	`122`	`'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },`
`123`	`123`	`'child' => { 'type' => 'string', 'description' => 'Child property.' }`
`124`	`124`	`},`
`125`		`- 'description' => 'This returns a child entity'`
	`125`	`+ 'description' => 'MyAPI::Child model'`
`126`	`126`	`)`
`127`	`127`	`end`
`128`	`128`	`end`