grape-swagger 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb6baac3bba57a4fd27f01c8129fbd128c0c88426f1408784f1e77ef870c65a
-  data.tar.gz: 88234909ace085c8b63f0534630ae8856eb15d383bee856c9fcc57079d0060a1
+  metadata.gz: eae164875a188218b1eb4e0e3a53039f8e661f3dd115b4cc9a6f415b3a92e64b
+  data.tar.gz: 6962782ea370ff7b4f84c62ed77f2fe1e7232332f3a238bce4c5af5b62eb1534
 SHA512:
-  metadata.gz: 3b50e2b60fb3d4a1876bac4587f740c27a624c02726153746dc79e76fb1a233d04a3b1b15844bf65a337484d551ac6ea84b04c85c1537138dfc4327149cbb654
-  data.tar.gz: 32a0e9014bf782a0f5a5417a307bf9325986d7d9df662e73174525792e9103d2a3ec3c4f8b3d7fbdc72829d7514ba299dd62adb361085020f37b104f9a29ee25
+  metadata.gz: 8b56b026ba97a2308579737c43daf0e9f619df0c91c511e424b533f99105faec83f9ddbcb3dd2f3d98866bffdbdecb13e652f302424f54ec4095c4605405319c
+  data.tar.gz: 2e88c630ade44d4c9395a18e690cad717f5a6ba6e6daae81624d0b7e6347f06c9d7d07ce85f16b5eb99ea25c1a716127cd8aac17c1367823ded3bd84151dbc47

data/.rubocop.yml

@@ -11,6 +11,9 @@ AllCops:
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
@@ -24,6 +27,12 @@ Layout/SpaceAroundMethodCallOperator:
 
 # Lint stuff
 #
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
 Lint/RaiseException:
   Enabled: true
 
@@ -39,6 +48,9 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
+Metrics/CyclomaticComplexity:
+  Max: 17
+
 Metrics/MethodLength:
   Exclude:
     - spec/**/*
@@ -64,3 +76,15 @@ Style/HashTransformValues:
 
 Style/RegexpLiteral:
   Enabled: false
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: false

data/.travis.yml

@@ -33,3 +33,5 @@ jobs:
     - rvm: 2.4.10
     - rvm: ruby-head
     - rvm: jruby-head
+
+    - env: GRAPE_VERSION=HEAD

data/CHANGELOG.md

@@ -9,6 +9,19 @@
 * Your contribution here.
 
 
+### 1.2.0 (July 1, 2020)
+
+#### Features
+
+* [#794](https://github.com/ruby-grape/grape-swagger/pull/794): Allow `entity_name` to be inherited, fixes issue #659 - [@urkle](https://github.com/urkle).
+* [#793](https://github.com/ruby-grape/grape-swagger/pull/793): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#798](https://github.com/ruby-grape/grape-swagger/pull/798): Modify full entity name separator - [@GarrettB71](https://github.com/GarrettB71).
+* [#796](https://github.com/ruby-grape/grape-swagger/pull/796): Support grape 1.4.0 - [@thedanielhanke](https://github.com/thedanielhanke).
+
+
 ### 1.1.0 (April 20, 2020)
 
 #### Features

data/Gemfile

@@ -14,6 +14,7 @@ gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.3.0'
              end
 
 gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
+
 group :development, :test do
   gem 'bundler'
   gem 'grape-entity'
@@ -26,12 +27,16 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 0.82', require: false
+  gem 'rubocop', '~> 0.85', require: false
 end
 
 group :test do
   gem 'coveralls_reborn', require: false
-  gem 'grape-swagger-entity'
+
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
   gem 'simplecov', require: false
+
+  unless ENV['MODEL_PARSER'] == 'grape-swagger-entity'
+    gem 'grape-swagger-entity', git: 'https://github.com/ruby-grape/grape-swagger-entity'
+  end
 end

data/README.md

@@ -43,16 +43,16 @@ This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sa
 
 The following versions of grape, grape-entity and grape-swagger can currently be used together.
 
-grape-swagger | swagger spec | grape                   | grape-entity | representable |
---------------|--------------|-------------------------|--------------|---------------|
-0.10.5        |     1.2      | >= 0.10.0 ... <= 0.14.0 |  < 0.5.0     | n/a           |
-0.11.0        |     1.2      |               >= 0.16.2 |  < 0.5.0     | n/a           |
-0.25.2        |     2.0      | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
-0.26.0        |     2.0      | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
-0.27.0        |     2.0      | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
-0.32.0        |     2.0      | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
-0.34.0        |     2.0      | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
->= 1.0.0      |     2.0      | >= 1.3.0                | >= 0.5.0     | >= 2.4.1      |
+| grape-swagger | swagger spec | grape                   | grape-entity | representable |
+| ------------- | ------------ | ----------------------- | ------------ | ------------- |
+| 0.10.5        | 1.2          | >= 0.10.0 ... <= 0.14.0 | < 0.5.0      | n/a           |
+| 0.11.0        | 1.2          | >= 0.16.2               | < 0.5.0      | n/a           |
+| 0.25.2        | 2.0          | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
+| 0.26.0        | 2.0          | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
+| 0.27.0        | 2.0          | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
+| 0.32.0        | 2.0          | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
+| 0.34.0        | 2.0          | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
+| >= 1.0.0      | 2.0          | >= 1.3.0                | >= 0.5.0     | >= 2.4.1      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -1381,6 +1381,94 @@ module API
 end
 ```
 
+#### Inheritance with allOf and discriminator
+```ruby
+module Entities
+  class Pet < Grape::Entity
+    expose :type, documentation: {
+      type: 'string',
+      is_discriminator: true,
+      required: true
+    }
+    expose :name, documentation: {
+      type: 'string',
+      required: true
+    }
+  end
+
+  class Cat < Pet
+    expose :huntingSkill, documentation: {
+      type: 'string',
+      description: 'The measured skill for hunting',
+      default: 'lazy',
+      values: %w[
+        clueless
+        lazy
+        adventurous
+        aggressive
+      ]
+    }
+  end
+end
+```
+
+Should generate this definitions:
+```JSON
+{
+  "definitions": {
+    "Pet": {
+      "type": "object",
+      "discriminator": "petType",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "petType": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "petType"
+      ]
+    },
+    "Cat": {
+      "description": "A representation of a cat",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Pet"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "huntingSkill": {
+              "type": "string",
+              "description": "The measured skill for hunting",
+              "default": "lazy",
+              "enum": [
+                "clueless",
+                "lazy",
+                "adventurous",
+                "aggressive"
+              ]
+            },
+            "petType": {
+              "type": "string",
+              "enum": ["Cat"]
+            }
+          },
+          "required": [
+            "huntingSkill",
+            "petType"
+          ]
+        }
+      ]
+    }
+  }
+}
+```
+
+
 
 
 ## Securing the Swagger UI <a name="oauth"></a>

data/UPGRADING.md

@@ -1,5 +1,31 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 1.2.0
+
+- The entity_name class method is now called on parent classes for inherited entities. Now you can do this
+
+```ruby
+module Some::Long::Module
+  class Base < Grape::Entity
+    # ... other shared logic
+    def self.entity_name
+      "V2::#{self.to_s.demodulize}"
+    end
+  end
+
+  def MyEntity < Base
+    # ....
+  end
+
+  def OtherEntity < Base
+    # revert back to the default behavior by hiding the method
+    private_class_method :entity_name
+  end
+end
+```
+
+- Full class name is modified to use `_` separator (e.g. `A_B_C` instead of `A::B::C`).
+
 ### Upgrading to >= 1.1.0
 
 Full class name is used for referencing entity by default (e.g. `A::B::C` instead of just `C`). `Entity` and `Entities` suffixes and prefixes are omitted (e.g. if entity name is `Entities::SomeScope::MyFavourite::Entity` only `SomeScope::MyFavourite` will be used).

data/grape-swagger.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.4'
-  s.add_runtime_dependency 'grape', '~> 1.3.0'
+  s.add_runtime_dependency 'grape', '~> 1.3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

data/lib/grape-swagger.rb

@@ -109,6 +109,7 @@ end
 module SwaggerDocumentationAdder
   attr_accessor :combined_namespaces, :combined_namespace_identifiers
   attr_accessor :combined_routes, :combined_namespace_routes
+
   include SwaggerRouting
 
   def add_swagger_documentation(options = {})

data/lib/grape-swagger/doc_methods/build_model_definition.rb

@@ -4,8 +4,8 @@ module GrapeSwagger
   module DocMethods
     class BuildModelDefinition
       class << self
-        def build(model, properties, required)
-          definition = { type: 'object', properties: properties }
+        def build(model, properties, required, other_def_properties = {})
+          definition = { type: 'object', properties: properties }.merge(other_def_properties)
 
           if required.nil?
             required_attrs = required_attributes(model)
@@ -17,6 +17,57 @@ module GrapeSwagger
           definition
         end
 
+        def parse_params_from_model(parsed_response, model, model_name)
+          if parsed_response.is_a?(Hash) && parsed_response.keys.first == :allOf
+            refs_or_models = parsed_response[:allOf]
+            parsed = parse_refs_and_models(refs_or_models, model)
+
+            {
+              allOf: parsed
+            }
+          else
+            properties, required = parsed_response
+            unless properties&.any?
+              raise GrapeSwagger::Errors::SwaggerSpec,
+                    "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
+            end
+            properties, other_def_properties = parse_properties(properties)
+
+            build(
+              model, properties, required, other_def_properties
+            )
+          end
+        end
+
+        def parse_properties(properties)
+          other_properties = {}
+
+          discriminator_key, discriminator_value =
+            properties.find do |_key, value|
+              value[:documentation].try(:[], :is_discriminator)
+            end
+
+          if discriminator_key
+            discriminator_value.delete(:documentation)
+            properties[discriminator_key] = discriminator_value
+
+            other_properties[:discriminator] = discriminator_key
+          end
+
+          [properties, other_properties]
+        end
+
+        def parse_refs_and_models(refs_or_models, model)
+          refs_or_models.map do |ref_or_models|
+            if ref_or_models.is_a?(Hash) && ref_or_models.keys.first == '$ref'
+              ref_or_models
+            else
+              properties, required = ref_or_models
+              GrapeSwagger::DocMethods::BuildModelDefinition.build(model, properties, required)
+            end
+          end
+        end
+
         private
 
         def required_attributes(model)

data/lib/grape-swagger/doc_methods/data_type.rb

@@ -48,14 +48,14 @@ module GrapeSwagger
         end
 
         def parse_entity_name(model)
-          if model.methods(false).include?(:entity_name)
+          if model.respond_to?(:entity_name)
             model.entity_name
           elsif model.to_s.end_with?('::Entity', '::Entities')
-            model.to_s.split('::')[0..-2].join('::')
+            model.to_s.split('::')[0..-2].join('_')
           elsif model.to_s.start_with?('Entity::', 'Entities::', 'Representable::')
-            model.to_s.split('::')[1..-1].join('::')
+            model.to_s.split('::')[1..-1].join('_')
           else
-            model.to_s
+            model.to_s.split('::').join('_')
           end
         end
 

data/lib/grape-swagger/doc_methods/operation_id.rb

@@ -16,8 +16,8 @@ module GrapeSwagger
 
         def manipulate(path)
           operation = path.split('/').map(&:capitalize).join
-          operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation[/\-(\w)/]
-          operation.gsub!(/\_(\w)/, &:upcase).delete!('_') if operation.include?('_')
+          operation.gsub!(/-(\w)/, &:upcase).delete!('-') if operation[/-(\w)/]
+          operation.gsub!(/_(\w)/, &:upcase).delete!('_') if operation.include?('_')
           operation.gsub!(/\.(\w)/, &:upcase).delete!('.') if operation[/\.(\w)/]
           if path.include?('{')
             operation.gsub!(/\{(\w)/, &:upcase)

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -77,6 +77,19 @@ module GrapeSwagger
 
           param_type ||= value_type[:param_type]
 
+          array_items = parse_array_item(
+            definitions,
+            type,
+            value_type
+          )
+
+          @parsed_param[:in] = param_type || 'formData'
+          @parsed_param[:items] = array_items
+          @parsed_param[:type] = 'array'
+          @parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
+        end
+
+        def parse_array_item(definitions, type, value_type)
           array_items = {}
           if definitions[value_type[:data_type]]
             array_items['$ref'] = "#/definitions/#{@parsed_param[:type]}"
@@ -91,10 +104,7 @@ module GrapeSwagger
 
           array_items[:default] = value_type[:default] if value_type[:default].present?
 
-          @parsed_param[:in] = param_type || 'formData'
-          @parsed_param[:items] = array_items
-          @parsed_param[:type] = 'array'
-          @parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
+          array_items
         end
 
         def document_additional_properties(settings)

data/lib/grape-swagger/endpoint.rb

@@ -196,10 +196,7 @@ module Grape
     end
 
     def response_object(route, options)
-      codes = http_codes_from_route(route)
-      codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2], examples: x[3], headers: x[4] } : x }
-
-      codes.each_with_object({}) do |value, memo|
+      codes(route).each_with_object({}) do |value, memo|
         value[:message] ||= ''
         memo[value[:code]] = { description: value[:message] }
 
@@ -225,6 +222,12 @@ module Grape
       end
     end
 
+    def codes(route)
+      http_codes_from_route(route).map do |x|
+        x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2], examples: x[3], headers: x[4] } : x
+      end
+    end
+
     def success_code?(code)
       status = code.is_a?(Array) ? code.first : code[:code]
       status.between?(200, 299)
@@ -340,12 +343,10 @@ module Grape
       parser = GrapeSwagger.model_parsers.find(model)
       raise GrapeSwagger::Errors::UnregisteredParser, "No parser registered for #{model_name}." unless parser
 
-      properties, required = parser.new(model, self).call
-      unless properties&.any?
-        raise GrapeSwagger::Errors::SwaggerSpec,
-              "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
-      end
-      @definitions[model_name] = GrapeSwagger::DocMethods::BuildModelDefinition.build(model, properties, required)
+      parsed_response = parser.new(model, self).call
+
+      @definitions[model_name] =
+        GrapeSwagger::DocMethods::BuildModelDefinition.parse_params_from_model(parsed_response, model, model_name)
 
       model_name
     end

data/lib/grape-swagger/version.rb

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

data/spec/issues/427_entity_as_string_spec.rb

@@ -35,5 +35,5 @@ describe '#427 nested entity given as string' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject.keys).to include 'RoleEntity', 'Permission::WithoutRole' }
+  specify { expect(subject.keys).to include 'RoleEntity', 'Permission_WithoutRole' }
 end

data/spec/issues/430_entity_definitions_spec.rb

@@ -55,6 +55,8 @@ describe 'definition names' do
             class Class7
               class SeventhEntity < Class6::SixthEntity
                 expose :seventh_thing
+
+                private_class_method :entity_name
               end
             end
           end
@@ -82,11 +84,11 @@ describe 'definition names' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject).to include 'TestDefinition::DummyEntities::WithVeryLongName::AnotherGroupingModule::Class1' }
-  specify { expect(subject).to include 'TestDefinition::DummyEntities::WithVeryLongName::AnotherGroupingModule::Class2' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class1' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class2' }
   specify { expect(subject).to include 'FooKlass' }
-  specify { expect(subject).to include 'TestDefinition::DummyEntities::WithVeryLongName::AnotherGroupingModule::Class4::FourthEntity' }
-  specify { expect(subject).to include 'TestDefinition::DummyEntities::WithVeryLongName::AnotherGroupingModule::Class5::FithEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class4_FourthEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class5_FithEntity' }
   specify { expect(subject).to include 'BarKlass' }
-  specify { expect(subject).to include 'TestDefinition::DummyEntities::WithVeryLongName::AnotherGroupingModule::Class7::SeventhEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class7_SeventhEntity' }
 end

data/spec/lib/data_type_spec.rb

@@ -49,6 +49,18 @@ describe GrapeSwagger::DocMethods::DataType do
     it { is_expected.to eq 'MyInteger' }
   end
 
+  describe 'Types in array with inherited entity_name' do
+    before do
+      stub_const 'EntityBase', Class.new
+      allow(EntityBase).to receive(:entity_name).and_return 'MyInteger'
+      stub_const 'MyEntity', Class.new(EntityBase)
+    end
+
+    let(:value) { { type: '[MyEntity]' } }
+
+    it { is_expected.to eq 'MyInteger' }
+  end
+
   describe 'Rack::Multipart::UploadedFile' do
     let(:value) { { type: Rack::Multipart::UploadedFile } }
 

data/spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb

@@ -189,7 +189,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
         'type' => 'object',
         'properties' => {
           'data' => {
-            '$ref' => '#/definitions/NestedModule::ApiResponse',
+            '$ref' => '#/definitions/NestedModule_ApiResponse',
             'description' => 'request data'
           }
         },
@@ -207,7 +207,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     end
 
     specify do
-      expect(subject['definitions']['NestedModule::ApiResponse']).not_to be_nil
+      expect(subject['definitions']['NestedModule_ApiResponse']).not_to be_nil
     end
 
     specify do

data/spec/swagger_v2/inheritance_and_discriminator_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Inheritance and Discriminator' do
+  before :all do
+    module InheritanceTest
+      module Entities
+        # example from https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#models-with-polymorphism-supports
+        class Pet < Grape::Entity
+          expose :type, documentation: {
+            type: 'string',
+            is_discriminator: true,
+            required: true
+          }
+          expose :name, documentation: {
+            type: 'string',
+            required: true
+          }
+        end
+
+        class Cat < Pet
+          expose :huntingSkill, documentation: {
+            type: 'string',
+            description: 'The measured skill for hunting',
+            default: 'lazy',
+            values: %w[
+              clueless
+              lazy
+              adventurous
+              aggressive
+            ]
+          }
+        end
+      end
+      class NameApi < Grape::API
+        add_swagger_documentation models: [Entities::Pet, Entities::Cat]
+      end
+    end
+  end
+
+  context 'Parent model' do
+    let(:app) { InheritanceTest::NameApi }
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['definitions']
+    end
+
+    specify do
+      subject['InheritanceTest_Entities_Pet'].key?('discriminator')
+      subject['InheritanceTest_Entities_Pet']['discriminator'] = 'type'
+      subject['InheritanceTest_Entities_Cat'].key?('allOf')
+    end
+  end
+end

data/spec/swagger_v2/reference_entity_spec.rb

@@ -22,6 +22,20 @@ describe 'referenceEntity' do
           expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
           expose :something, documentation: { type: Something, desc: 'Something interesting.' }
         end
+
+        class Base < Grape::Entity
+          def self.entity_name
+            parts = to_s.split('::')
+
+            "MyAPI::#{parts.last}"
+          end
+
+          expose :title, documentation: { type: 'string', desc: 'Title of the parent.' }
+        end
+
+        class Child < Base
+          expose :child, documentation: { type: 'string', desc: 'Child property.' }
+        end
       end
 
       class ResponseModelApi < Grape::API
@@ -40,6 +54,16 @@ describe 'referenceEntity' do
           present kind, with: Entities::Kind
         end
 
+        desc 'This returns a child entity',
+             entity: Entities::Child,
+             http_codes: [
+               { code: 200, message: 'OK', model: Entities::Child }
+             ]
+        get '/child' do
+          child = OpenStruct.new text: 'child'
+          present child, with: Entities::Child
+        end
+
         add_swagger_documentation # models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
       end
     end
@@ -49,36 +73,57 @@ describe 'referenceEntity' do
     MyAPI::ResponseModelApi
   end
 
-  subject do
-    get '/swagger_doc/kind'
-    JSON.parse(last_response.body)
+  describe 'kind' do
+    subject do
+      get '/swagger_doc/kind'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['paths']['/kind']['get']['parameters']).to eq [{
+        'in' => 'query',
+        'name' => 'something',
+        'description' => 'Something interesting.',
+        'type' => 'SomethingCustom',
+        'required' => false
+      }]
+
+      expect(subject['definitions'].keys).to include 'SomethingCustom'
+      expect(subject['definitions']['SomethingCustom']).to eq(
+        'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
+      )
+
+      expect(subject['definitions'].keys).to include 'KindCustom'
+      expect(subject['definitions']['KindCustom']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
+          'something' => {
+            '$ref' => '#/definitions/SomethingCustom',
+            'description' => 'Something interesting.'
+          }
+        },
+        'description' => 'This returns kind and something or an error'
+      )
+    end
   end
 
-  it 'should document specified models' do
-    expect(subject['paths']['/kind']['get']['parameters']).to eq [{
-      'in' => 'query',
-      'name' => 'something',
-      'description' => 'Something interesting.',
-      'type' => 'SomethingCustom',
-      'required' => false
-    }]
-
-    expect(subject['definitions'].keys).to include 'SomethingCustom'
-    expect(subject['definitions']['SomethingCustom']).to eq(
-      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
-    )
-
-    expect(subject['definitions'].keys).to include 'KindCustom'
-    expect(subject['definitions']['KindCustom']).to eq(
-      'type' => 'object',
-      'properties' => {
-        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
-        'something' => {
-          '$ref' => '#/definitions/SomethingCustom',
-          'description' => 'Something interesting.'
-        }
-      },
-      'description' => 'This returns kind and something or an error'
-    )
+  describe 'child' do
+    subject do
+      get '/swagger_doc/child'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['definitions'].keys).to include 'MyAPI::Child'
+      expect(subject['definitions']['MyAPI::Child']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },
+          'child' => { 'type' => 'string', 'description' => 'Child property.' }
+        },
+        'description' => 'This returns a child entity'
+      )
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tim Vandecasteele
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-description: 
+        version: '1.3'
+description:
 email:
 - tim.vandecasteele@gmail.com
 executables: []
@@ -156,6 +156,7 @@ files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host_spec.rb
+- spec/swagger_v2/inheritance_and_discriminator_spec.rb
 - spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
@@ -179,7 +180,7 @@ homepage: https://github.com/ruby-grape/grape-swagger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
   with Swagger.
@@ -279,6 +280,7 @@ test_files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host_spec.rb
+- spec/swagger_v2/inheritance_and_discriminator_spec.rb
 - spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb