grape-swagger 1.4.0 → 1.5.0

data/spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'parsing additional_parameters' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :things do
+        class Element < Grape::Entity
+          expose :id
+        end
+
+        params do
+          optional :closed, type: Hash, documentation: { additional_properties: false, in: 'body' } do
+            requires :only
+          end
+          optional :open, type: Hash, documentation: { additional_properties: true }
+          optional :type_limited, type: Hash, documentation: { additional_properties: String }
+          optional :ref_limited, type: Hash, documentation: { additional_properties: Element }
+          optional :fallback, type: Hash, documentation: { additional_properties: { type: 'integer' } }
+        end
+        post do
+          present params
+        end
+      end
+
+      add_swagger_documentation format: :json, models: [Element]
+    end
+  end
+
+  subject do
+    get '/swagger_doc/things'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'POST' do
+    specify do
+      expect(subject.dig('paths', '/things', 'post', 'parameters')).to eql(
+        [
+          { 'name' => 'postThings', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postThings' } }
+        ]
+      )
+    end
+
+    specify do
+      expect(subject.dig('definitions', 'postThings')).to eql(
+        'type' => 'object',
+        'properties' => {
+          'closed' => {
+            'type' => 'object',
+            'additionalProperties' => false,
+            'properties' => {
+              'only' => { 'type' => 'string' }
+            },
+            'required' => ['only']
+          },
+          'open' => {
+            'type' => 'object',
+            'additionalProperties' => true
+          },
+          'type_limited' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              'type' => 'string'
+            }
+          },
+          'ref_limited' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              '$ref' => '#/definitions/Element'
+            }
+          },
+          'fallback' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              'type' => 'integer'
+            }
+          }
+        }
+      )
+    end
+  end
+end

data/spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb

@@ -13,7 +13,7 @@ describe 'moving body/formData Params to definitions' do
                detail: 'more details description',
                success: Entities::UseNestedWithAddress
           params do
-            optional :contact, type: Hash do
+            optional :contact, type: Hash, documentation: { additional_properties: true } do
               requires :name, type: String, documentation: { desc: 'name', in: 'body' }
               optional :addresses, type: Array do
                 requires :street, type: String, documentation: { desc: 'street', in: 'body' }
@@ -96,6 +96,27 @@ describe 'moving body/formData Params to definitions' do
           end
         end
 
+        namespace :nested_params_array do
+          desc 'post in body with array of nested parameters',
+               detail: 'more details description',
+               success: Entities::UseNestedWithAddress
+          params do
+            optional :contacts, type: Array, documentation: { additional_properties: false } do
+              requires :name, type: String, documentation: { desc: 'name', in: 'body' }
+              optional :addresses, type: Array do
+                requires :street, type: String, documentation: { desc: 'street', in: 'body' }
+                requires :postcode, type: String, documentation: { desc: 'postcode', in: 'body' }
+                requires :city, type: String, documentation: { desc: 'city', in: 'body' }
+                optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+              end
+            end
+          end
+
+          post '/in_body' do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
         add_swagger_documentation
       end
     end
@@ -115,7 +136,7 @@ describe 'moving body/formData Params to definitions' do
       specify do
         expect(subject['paths']['/simple_nested_params/in_body']['post']['parameters']).to eql(
           [
-            { 'name' => 'SimpleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postSimpleNestedParamsInBody' } }
+            { 'name' => 'postSimpleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postSimpleNestedParamsInBody' } }
           ]
         )
       end
@@ -126,6 +147,7 @@ describe 'moving body/formData Params to definitions' do
           'properties' => {
             'contact' => {
               'type' => 'object',
+              'additionalProperties' => true,
               'properties' => {
                 'name' => { 'type' => 'string', 'description' => 'name' },
                 'addresses' => {
@@ -155,13 +177,13 @@ describe 'moving body/formData Params to definitions' do
         expect(subject['paths']['/simple_nested_params/in_body/{id}']['put']['parameters']).to eql(
           [
             { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-            { 'name' => 'SimpleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putSimpleNestedParamsInBody' } }
+            { 'name' => 'putSimpleNestedParamsInBodyId', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putSimpleNestedParamsInBodyId' } }
           ]
         )
       end
 
       specify do
-        expect(subject['definitions']['putSimpleNestedParamsInBody']).to eql(
+        expect(subject['definitions']['putSimpleNestedParamsInBodyId']).to eql(
           'type' => 'object',
           'properties' => {
             'name' => { 'type' => 'string', 'description' => 'name' },
@@ -192,7 +214,7 @@ describe 'moving body/formData Params to definitions' do
         expect(subject['paths']['/multiple_nested_params/in_body']['post']['parameters']).to eql(
           [
             {
-              'name' => 'MultipleNestedParamsInBody',
+              'name' => 'postMultipleNestedParamsInBody',
               'in' => 'body',
               'required' => true,
               'schema' => { '$ref' => '#/definitions/postMultipleNestedParamsInBody' }
@@ -245,13 +267,13 @@ describe 'moving body/formData Params to definitions' do
         expect(subject['paths']['/multiple_nested_params/in_body/{id}']['put']['parameters']).to eql(
           [
             { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-            { 'name' => 'MultipleNestedParamsInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putMultipleNestedParamsInBody' } }
+            { 'name' => 'putMultipleNestedParamsInBodyId', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putMultipleNestedParamsInBodyId' } }
           ]
         )
       end
 
       specify do
-        expect(subject['definitions']['putMultipleNestedParamsInBody']).to eql(
+        expect(subject['definitions']['putMultipleNestedParamsInBodyId']).to eql(
           'type' => 'object',
           'properties' => {
             'name' => { 'type' => 'string', 'description' => 'name' },
@@ -280,4 +302,54 @@ describe 'moving body/formData Params to definitions' do
       end
     end
   end
+
+  describe 'array of nested body parameters given' do
+    subject do
+      get '/swagger_doc/nested_params_array'
+      JSON.parse(last_response.body)
+    end
+
+    describe 'POST' do
+      specify do
+        expect(subject['paths']['/nested_params_array/in_body']['post']['parameters']).to eql(
+          [
+            { 'name' => 'postNestedParamsArrayInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postNestedParamsArrayInBody' } }
+          ]
+        )
+      end
+
+      specify do
+        expect(subject['definitions']['postNestedParamsArrayInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'contacts' => {
+              'type' => 'array',
+              'items' => {
+                'type' => 'object',
+                'additionalProperties' => false,
+                'properties' => {
+                  'name' => { 'type' => 'string', 'description' => 'name' },
+                  'addresses' => {
+                    'type' => 'array',
+                    'items' => {
+                      'type' => 'object',
+                      'properties' => {
+                        'street' => { 'type' => 'string', 'description' => 'street' },
+                        'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                        'city' => { 'type' => 'string', 'description' => 'city' },
+                        'country' => { 'type' => 'string', 'description' => 'country' }
+                      },
+                      'required' => %w[street postcode city]
+                    }
+                  }
+                },
+                'required' => %w[name]
+              }
+            }
+          },
+          'description' => 'post in body with array of nested parameters'
+        )
+      end
+    end
+  end
 end

data/spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb

@@ -85,7 +85,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     specify do
       expect(subject['paths']['/wo_entities/in_body']['post']['parameters']).to eql(
         [
-          { 'name' => 'WoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
+          { 'name' => 'postWoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
         ]
       )
     end
@@ -107,13 +107,13 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/wo_entities/in_body/{key}']['put']['parameters']).to eql(
         [
           { 'in' => 'path', 'name' => 'key', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          { 'name' => 'WoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBody' } }
+          { 'name' => 'putWoEntitiesInBodyKey', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBodyKey' } }
         ]
       )
     end
 
     specify do
-      expect(subject['definitions']['putWoEntitiesInBody']).to eql(
+      expect(subject['definitions']['putWoEntitiesInBodyKey']).to eql(
         'description' => 'put in body /wo entity',
         'type' => 'object',
         'properties' => {
@@ -134,7 +134,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     specify do
       expect(subject['paths']['/with_entities/in_body']['post']['parameters']).to eql(
         [
-          { 'name' => 'WithEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWithEntitiesInBody' } }
+          { 'name' => 'postWithEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWithEntitiesInBody' } }
         ]
       )
     end
@@ -154,13 +154,13 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/with_entities/in_body/{id}']['put']['parameters']).to eql(
         [
           { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          { 'name' => 'WithEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWithEntitiesInBody' } }
+          { 'name' => 'putWithEntitiesInBodyId', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWithEntitiesInBodyId' } }
         ]
       )
     end
 
     specify do
-      expect(subject['definitions']['putWithEntitiesInBody']).to eql(
+      expect(subject['definitions']['putWithEntitiesInBodyId']).to eql(
         'type' => 'object',
         'properties' => {
           'name' => { 'type' => 'string', 'description' => 'name' }
@@ -174,7 +174,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     let(:request_parameters_definition) do
       [
         {
-          'name' => 'WithEntityParam',
+          'name' => 'postWithEntityParam',
           'in' => 'body',
           'required' => true,
           'schema' => {

data/spec/swagger_v2/boolean_params_spec.rb

@@ -9,6 +9,7 @@ describe 'Boolean Params' do
 
       params do
         requires :a_boolean, type: Grape::API::Boolean
+        optional :another_boolean, type: Grape::API::Boolean, default: false
       end
       post :splines do
         { message: 'hi' }
@@ -27,7 +28,8 @@ describe 'Boolean Params' do
 
   it 'converts boolean types' do
     expect(subject).to eq [
-      { 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true }
+      { 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true },
+      { 'in' => 'formData', 'name' => 'another_boolean', 'type' => 'boolean', 'required' => false, 'default' => false }
     ]
   end
 end

data/spec/swagger_v2/param_values_spec.rb

@@ -141,7 +141,7 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
         'name' => 'letter',
         'type' => 'string',
         'required' => true,
-        'enum' => 'string'
+        'enum' => %w[string]
       }]
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -35,8 +35,7 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".github/dependabot.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -102,6 +101,8 @@ files:
 - spec/issues/776_multiple_presents_spec.rb
 - spec/issues/784_extensions_on_params_spec.rb
 - spec/issues/809_utf8_routes_spec.rb
+- spec/issues/832_array_hash_float_decimal_spec.rb
+- spec/issues/847_route_param_options_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -127,6 +128,7 @@ files:
 - spec/support/namespace_tags.rb
 - spec/support/the_paths_definitions.rb
 - spec/swagger_v2/api_documentation_spec.rb
+- spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb
 - spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb
 - spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb
 - spec/swagger_v2/api_swagger_v2_detail_spec.rb
@@ -187,7 +189,8 @@ files:
 homepage: https://github.com/ruby-grape/grape-swagger
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -196,119 +199,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
   with Swagger.
-test_files:
-- spec/issues/267_nested_namespaces.rb
-- spec/issues/403_versions_spec.rb
-- spec/issues/427_entity_as_string_spec.rb
-- spec/issues/430_entity_definitions_spec.rb
-- spec/issues/532_allow_custom_format_spec.rb
-- spec/issues/533_specify_status_code_spec.rb
-- spec/issues/537_enum_values_spec.rb
-- spec/issues/539_array_post_body_spec.rb
-- spec/issues/542_array_of_type_in_post_body_spec.rb
-- spec/issues/553_align_array_put_post_params_spec.rb
-- spec/issues/572_array_post_body_spec.rb
-- spec/issues/579_align_put_post_parameters_spec.rb
-- spec/issues/582_file_response_spec.rb
-- spec/issues/587_range_parameter_delimited_by_dash_spec.rb
-- spec/issues/605_root_route_documentation_spec.rb
-- spec/issues/650_params_array_spec.rb
-- spec/issues/680_keep_204_error_schemas_spec.rb
-- spec/issues/751_deeply_nested_objects_spec.rb
-- spec/issues/776_multiple_presents_spec.rb
-- spec/issues/784_extensions_on_params_spec.rb
-- spec/issues/809_utf8_routes_spec.rb
-- spec/lib/data_type_spec.rb
-- spec/lib/endpoint/params_parser_spec.rb
-- spec/lib/endpoint_spec.rb
-- spec/lib/extensions_spec.rb
-- spec/lib/format_data_spec.rb
-- spec/lib/model_parsers_spec.rb
-- spec/lib/move_params_spec.rb
-- spec/lib/oapi_tasks_spec.rb
-- spec/lib/operation_id_spec.rb
-- spec/lib/optional_object_spec.rb
-- spec/lib/parse_params_spec.rb
-- spec/lib/path_string_spec.rb
-- spec/lib/produces_consumes_spec.rb
-- spec/lib/tag_name_description_spec.rb
-- spec/lib/version_spec.rb
-- spec/spec_helper.rb
-- spec/support/empty_model_parser.rb
-- spec/support/grape_version.rb
-- spec/support/mock_parser.rb
-- spec/support/model_parsers/entity_parser.rb
-- spec/support/model_parsers/mock_parser.rb
-- spec/support/model_parsers/representable_parser.rb
-- spec/support/namespace_tags.rb
-- spec/support/the_paths_definitions.rb
-- spec/swagger_v2/api_documentation_spec.rb
-- spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb
-- spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb
-- spec/swagger_v2/api_swagger_v2_detail_spec.rb
-- spec/swagger_v2/api_swagger_v2_extensions_spec.rb
-- spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb
-- spec/swagger_v2/api_swagger_v2_global_configuration_spec.rb
-- spec/swagger_v2/api_swagger_v2_hash_and_array_spec.rb
-- spec/swagger_v2/api_swagger_v2_headers_spec.rb
-- spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb
-- spec/swagger_v2/api_swagger_v2_hide_param_spec.rb
-- spec/swagger_v2/api_swagger_v2_ignore_defaults_spec.rb
-- spec/swagger_v2/api_swagger_v2_mounted_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_spec.rb
-- spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_examples_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb
-- spec/swagger_v2/api_swagger_v2_spec.rb
-- spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
-- spec/swagger_v2/api_swagger_v2_type-format_spec.rb
-- spec/swagger_v2/boolean_params_spec.rb
-- spec/swagger_v2/default_api_spec.rb
-- spec/swagger_v2/deprecated_field_spec.rb
-- spec/swagger_v2/description_not_initialized_spec.rb
-- spec/swagger_v2/endpoint_versioned_path_spec.rb
-- spec/swagger_v2/errors_spec.rb
-- spec/swagger_v2/float_api_spec.rb
-- spec/swagger_v2/form_params_spec.rb
-- spec/swagger_v2/grape-swagger_spec.rb
-- 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
-- spec/swagger_v2/namespace_tags_spec.rb
-- spec/swagger_v2/namespaced_api_spec.rb
-- spec/swagger_v2/nicknamed_api_spec.rb
-- spec/swagger_v2/operation_id_api_spec.rb
-- spec/swagger_v2/param_multi_type_spec.rb
-- spec/swagger_v2/param_type_spec.rb
-- spec/swagger_v2/param_values_spec.rb
-- spec/swagger_v2/params_array_collection_format_spec.rb
-- spec/swagger_v2/params_array_spec.rb
-- spec/swagger_v2/params_example_spec.rb
-- spec/swagger_v2/params_hash_spec.rb
-- spec/swagger_v2/params_nested_spec.rb
-- spec/swagger_v2/parent_less_namespace_spec.rb
-- spec/swagger_v2/reference_entity_spec.rb
-- spec/swagger_v2/security_requirement_spec.rb
-- spec/swagger_v2/simple_mounted_api_spec.rb
-- spec/version_spec.rb
+test_files: []

data/.github/workflows/rubocop.yml

@@ -1,26 +0,0 @@
-name: Rubocop
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  rubocop:
-    name: Rubocop
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
-      - run: gem install rubocop --no-doc
-      - run: rubocop --format progress --format json --out rubocop.json
-        id: rubocop
-      - uses: duderman/rubocop-annotate-action@v0.1.0
-        with:
-          path: rubocop.json
-        if: ${{ failure() }}

data/.github/workflows/ruby.yml

@@ -1,32 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  rspec:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-        grape-version: [1.5.3, 1.4.0, 1.3.3]
-        model-parser: [grape-swagger-entity, grape-swagger-representable, '']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        GRAPE_VERSION: ${{ matrix.grape-version }}
-        MODEL_PARSER: ${{ matrix.model-parser }}
-        bundler-cache: true
-    - name: Run rspec
-      run: bundle exec rspec
-    - name: Run rubocop
-      run: bundle exec rubocop