grape-swagger 1.3.0 → 1.4.2

data/spec/swagger_v2/param_multi_type_spec.rb

@@ -16,6 +16,7 @@ describe 'Params Multi Types' do
         requires :another_input, type: [String, Integer]
       end
       post :action do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -61,6 +62,7 @@ describe 'Params Multi Types' do
           requires :another_input, type: [String, Integer]
         end
         post :action do
+          { message: 'hi' }
         end
 
         add_swagger_documentation

data/spec/swagger_v2/param_type_spec.rb

@@ -11,12 +11,14 @@ describe 'Params Types' do
         requires :input, type: String
       end
       post :action do
+        { message: 'hi' }
       end
 
       params do
         requires :input, type: String, default: '14', documentation: { type: 'email', default: '42' }
       end
       post :action_with_doc do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -49,6 +51,7 @@ describe 'Params Types' do
             requires :input, type: String
           end
           post :action do
+            { message: 'hi' }
           end
 
           add_swagger_documentation

data/spec/swagger_v2/param_values_spec.rb

@@ -12,24 +12,28 @@ describe 'Convert values to enum or Range' do
         requires :letter, type: String, values: %w[a b c]
       end
       post :plain_array do
+        { message: 'hi' }
       end
 
       params do
         requires :letter, type: String, values: proc { %w[d e f] }
       end
       post :array_in_proc do
+        { message: 'hi' }
       end
 
       params do
         requires :letter, type: String, values: 'a'..'z'
       end
       post :range_letter do
+        { message: 'hi' }
       end
 
       params do
         requires :integer, type: Integer, values: -5..5
       end
       post :range_integer do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -107,12 +111,14 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
         requires :letter, type: String, values: proc { 'string' }
       end
       post :non_array_in_proc do
+        { message: 'hi' }
       end
 
       params do
         requires :float, type: Float, values: -5.0..5.0
       end
       post :range_float do
+        { message: 'hi' }
       end
 
       add_swagger_documentation

data/spec/swagger_v2/params_example_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Param example' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :id, type: Integer, documentation: { example: 123 }
+        optional :name, type: String, documentation: { example: 'Person' }
+        optional :obj, type: 'Object', documentation: { example: { 'foo' => 'bar' } }
+      end
+
+      get '/endpoint_with_examples' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe 'documentation with parameter examples' do
+    subject do
+      get '/swagger_doc/endpoint_with_examples'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/endpoint_with_examples']['get']['parameters']).to eql(
+        [
+          { 'in' => 'query', 'name' => 'id', 'type' => 'integer', 'example' => 123, 'format' => 'int32', 'required' => true },
+          { 'in' => 'query', 'name' => 'name', 'type' => 'string', 'example' => 'Person', 'required' => false },
+          { 'in' => 'query', 'name' => 'obj', 'type' => 'Object', 'example' => { 'foo' => 'bar' }, 'required' => false }
+        ]
+      )
+    end
+  end
+end

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -4,11 +4,14 @@ require 'spec_helper'
 
 describe 'a simple mounted api' do
   before :all do
+    # rubocop:disable Lint/EmptyClass
     class CustomType; end
+    # rubocop:enable Lint/EmptyClass
 
     class SimpleMountedApi < Grape::API
       desc 'Document root'
       get do
+        { message: 'hi' }
       end
 
       desc 'This gets something.',

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
+- LeFnord
 - Tim Vandecasteele
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -26,18 +27,21 @@ dependencies:
         version: '1.3'
 description:
 email:
+- pscholz.le@gmail.com
 - tim.vandecasteele@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-gemset"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dangerfile
@@ -95,7 +99,10 @@ files:
 - 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/issues/832_array_hash_float_decimal_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -121,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
@@ -168,8 +176,9 @@ files:
 - 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_fromat_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
@@ -189,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
@@ -220,7 +229,10 @@ test_files:
 - 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/issues/832_array_hash_float_decimal_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -246,6 +258,7 @@ test_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
@@ -293,8 +306,9 @@ test_files:
 - 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_fromat_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

data/.travis.yml

@@ -1,40 +0,0 @@
-language: ruby
-
-os: linux
-
-before_install:
-  - gem install bundler
-
-after_success:
-  - bundle exec danger
-
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-env:
-  - GRAPE_VERSION=1.3.3
-  - GRAPE_VERSION=1.4.0 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.4.0 MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=1.4.0
-  - GRAPE_VERSION=HEAD
-
-jobs:
-  fast_finish: true
-
-  include:
-    - rvm: 2.4.10
-      env:
-    - rvm: ruby-head
-      env:
-    - rvm: jruby-head
-      env:
-    - rvm: truffleruby-head
-      env:
-      script: bundle exec rake spec
-
-  allow_failures:
-    - rvm: 2.4.10
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby-head