grape-swagger 0.33.0 → 0.34.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd05d00a2d4f16e3ecfa826aa0053928231d9e3f2e3316ea1f612c804284d858
-  data.tar.gz: 7b6637a45c95035939be0a52312f6f16f62bf1f67d788c1d1e6884b1611f6322
+  metadata.gz: 1adc600f72fbf0b270ca597d538fc692ab1b06d96aec051dd5aac93b0d9541e4
+  data.tar.gz: 90b38eef4b8736e686c57b9ae3a0a047c3be752076a3c51fe81a2b2ace4534d7
 SHA512:
-  metadata.gz: 05541a6f1670c730a7fb3c7c4acc422aeecdf562fc3f77477e0721628dac3aeec147ce0653d74a1a7560ddd36fc90075fae23ae58d1ed424445290e801d2856e
-  data.tar.gz: ac5ce4eadc5bc9dd4ecdac8bd514a339c9157b77f661c8e696c6a527dfc0a2d6d09acc8527351ac1ba0cbbf0e8894959baa5daa7eb0cd41997ca1b9dd9ddb065
+  metadata.gz: becc52b89b55eaf20b8e17c39b2a2d53592fbe6a92feb1c50d6f1b80d4ee0b14edb16dbcb5e6168a5d7830b80f8d412af19c78fc0a645aabd1ca3570ed3e34fb
+  data.tar.gz: c6da9f8e4818368d67f525898d69b9d15fe46d429cb4223fb44ff1f4d2c52aefff99f8487cf8ecdf702153d1a3d7dbaed93756a0967bbdadd871fdc26f8af229

data/.rubocop.yml

@@ -4,14 +4,19 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
@@ -19,11 +24,6 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
 Metrics/MethodLength:
   Exclude:
     - spec/**/*

data/.rubocop_todo.yml

@@ -13,12 +13,6 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'grape-swagger.gemspec'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Lint/UnneededCopEnableDirective:
-  Exclude:
-    - 'spec/lib/optional_object_spec.rb'
-
 # Offense count: 30
 Metrics/AbcSize:
   Max: 59

data/.travis.yml

@@ -7,28 +7,27 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 env:
-  - MODEL_PARSER=grape-swagger-entity
-  - MODEL_PARSER=grape-swagger-representable
+  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-entity
+  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-representable
   - GRAPE_VERSION=1.0.3
-  - GRAPE_VERSION=1.2.4
-  - GRAPE_VERSION=HEAD
+  - GRAPE_VERSION=1.2.5
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.3.8
-      env:
+    - rvm: 2.4.9
+      env: GRAPE_VERSION=1.2.5
     - rvm: ruby-head
-      env:
+      env: GRAPE_VERSION=HEAD
     - rvm: jruby-head
       env:
 
   allow_failures:
-    - rvm: 2.3.8
+    - rvm: 2.4.9
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -6,7 +6,28 @@
 
 #### Fixes
 
-* Your contribution here.
+### 0.34.2 (January 20, 2020)
+
+#### Fixes
+
+* [#773](https://github.com/ruby-grape/grape-swagger/pull/773): Freeze rack version to 2.0.8 - [@LeFnord](https://github.com/LeFnord).
+
+
+### 0.34.0 (January 11, 2020)
+
+#### Features
+
+* [#768](https://github.com/ruby-grape/grape-swagger/pull/768): Uses ruby 2.7, fixes grape to 1.2.5 (cause of dry-types) - [@LeFnord](https://github.com/LeFnord).
+* [#761](https://github.com/ruby-grape/grape-swagger/pull/761): Add an option to configure root element for responses - [@bikolya](https://github.com/bikolya).
+* [#749](https://github.com/ruby-grape/grape-swagger/pull/749): Drop support for Ruby 2.3 and below - [@LeFnord](https://github.com/LeFnord).
+
+#### Fixes
+
+* [#758](https://github.com/ruby-grape/grape-swagger/pull/758): Handle cases where a route's prefix is a nested URL - [@SimonKaluza](https://github.com/simonkaluza).
+* [#757](https://github.com/ruby-grape/grape-swagger/pull/757): Fix `array_use_braces` for nested body params - [@bikolya](https://github.com/bikolya).
+* [#756](https://github.com/ruby-grape/grape-swagger/pull/756): Fix reference creation when custom type for documentation is provided - [@bikolya](https://github.com/bikolya).
+* [#764](https://github.com/ruby-grape/grape-swagger/pull/764): Fix root element for multi-word entities - [@bikolya](https://github.com/bikolya).
+
 
 ### 0.33.0 (June 21, 2019)
 
@@ -17,6 +38,11 @@
 * [#743](https://github.com/ruby-grape/grape-swagger/pull/743): CI: use 2.4.6, 2.5.5 - [@olleolleolle](https://github.com/olleolleolle).
 * [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
 
+#### Changes
+
+* [#749](https://github.com/ruby-grape/grape-swagger/pull/749) Drop support for Ruby 2.3 and below - [@LeFnord](https://github.com/LeFnord).
+
+
 ### 0.32.1 (December 7, 2018)
 
 #### Fixes
@@ -24,6 +50,7 @@
 * [#731](https://github.com/ruby-grape/grape-swagger/pull/731): Skip empty parameters and tags arrays - [@fotos](https://github.com/fotos).
 * [#729](https://github.com/ruby-grape/grape-swagger/pull/729): Allow empty security array for endpoints - [@fotos](https://github.com/fotos).
 
+
 ### 0.32.0 (November 26, 2018)
 
 #### Features
@@ -34,13 +61,15 @@
 
 * [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
 
+
 ### 0.31.1 (October 23, 2018)
 
 #### Features
 
 * [#710](https://github.com/ruby-grape/grape-swagger/issues/710): Re-implement `api_documentation` and `specific_api_documentation` options - [@dblock](https://github.com/dblock).
 
-###  0.31.0 (August 22, 2018)
+
+### 0.31.0 (August 22, 2018)
 
 #### Features
 
@@ -50,13 +79,15 @@
 * [#691](https://github.com/ruby-grape/grape-swagger/pull/691): Disregard order when parsing request params for arrays - [@jdmurphy](https://github.com/jdmurphy).
 * [#696](https://github.com/ruby-grape/grape-swagger/pull/696): Delegate required properties parsing to model parsers - [@Bugagazavr](https://github.com/Bugagazavr).
 
-###  0.30.1 (July 19, 2018)
+
+### 0.30.1 (July 19, 2018)
 
 #### Features
 
 * [#686](https://github.com/ruby-grape/grape-swagger/pull/686): Allow response headers for responses with no content and for files - [@jdmurphy](https://github.com/jdmurphy).
 
-###  0.30.0 (July 19, 2018)
+
+### 0.30.0 (July 19, 2018)
 
 #### Features
 
@@ -67,7 +98,8 @@
 * [#681](https://github.com/ruby-grape/grape-swagger/pull/681): Provide error schemas when an endpoint can return a 204 - [@adstratm](https://github.com/adstratm).
 * [#683](https://github.com/ruby-grape/grape-swagger/pull/683): Fix handling of arrays of complex entities in params so that valid OpenAPI spec is generated - [@jdmurphy](https://github.com/jdmurphy).
 
-###  0.29.0 (May 22, 2018)
+
+### 0.29.0 (May 22, 2018)
 
 #### Features
 
@@ -81,6 +113,7 @@
 * [#669](https://github.com/ruby-grape/grape-swagger/pull/669): Fix handling of http status codes from routes - [@milgner](https://github.com/milgner).
 * [#672](https://github.com/ruby-grape/grape-swagger/pull/672): Rename 'notes' to 'detail' in README - [@kjleitz](https://github.com/kjleitz).
 
+
 ### 0.28.0 (February 3, 2018)
 
 #### Features
@@ -97,6 +130,7 @@
 * [#654](https://github.com/ruby-grape/grape-swagger/pull/654): Allow setting the consumes for PATCH methods - [@anakinj](https://github.com/anakinj).
 * [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
 
+
 ### 0.27.3 (July 11, 2017)
 
 #### Features
@@ -107,6 +141,7 @@
 
 * [#616](https://github.com/ruby-grape/grape-swagger/pull/616): Fix swagger to show root path ([#605](https://github.com/ruby-grape/grape-swagger/issue/605)) - [@NightWolf007](https://github.com/NightWolf007).
 
+
 ### 0.27.2 (May 11, 2017)
 
 #### Features
@@ -115,13 +150,15 @@
 * [#596](https://github.com/ruby-grape/grape-swagger/pull/596): Use route_settings for hidden and operations extensions - [@thogg4](https://github.com/thogg4).
 * [#607](https://github.com/ruby-grape/grape-swagger/pull/607): Allow body parameter name to be specified - [@tjwp](https://github.com/tjwp).
 
+
 ### 0.27.1 (April 28, 2017)
 
 #### Features
 
 * [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
 
-###  0.27.0 (March 27, 2017)
+
+### 0.27.0 (March 27, 2017)
 
 #### Features
 
@@ -136,6 +173,7 @@
 * [#586](https://github.com/ruby-grape/grape-swagger/pull/586): Issue #587: Parameters delimited by dash cause exception - [@risa](https://github.com/risa).
 * [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
 
+
 ### 0.26.1 (February 3, 2017)
 
 #### Features
@@ -150,6 +188,7 @@
 * [#562](https://github.com/ruby-grape/grape-swagger/pull/562): The guard method should allow regular object methods as arguments - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
 * [#574](https://github.com/ruby-grape/grape-swagger/pull/574): Fixes #572: `is_array` should only be applied to success - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.26.0 (January 9, 2017)
 
 #### Features
@@ -162,6 +201,7 @@
 
 * [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
 
+
 ### 0.25.3 (December 18, 2016)
 
 #### Features
@@ -175,12 +215,14 @@
 * [#548](https://github.com/ruby-grape/grape-swagger/pull/548): Remove dots from operation id - [@frodrigo](https://github.com/frodrigo).
 * [#553](https://github.com/ruby-grape/grape-swagger/pull/553): Align array params for post, put request - addition to [#540](https://github.com/ruby-grape/grape-swagger/pull/540) - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.25.2 (November 30, 2016)
 
 #### Fixes
 
 * [#544](https://github.com/ruby-grape/grape-swagger/pull/544): Fixes #539 and #542; not all of 530 was commited - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.25.1 (November 29, 2016)
 
 #### Features
@@ -193,6 +235,7 @@
 * [#540](https://github.com/ruby-grape/grape-swagger/pull/540): Corrects exposing of array in post body - [@LeFnord](https://github.com/LeFnord).
 * [#509](https://github.com/ruby-grape/grape-swagger/pull/509), [#529](https://github.com/ruby-grape/grape-swagger/pull/529): Making parent-less routes working - [@mur-wtag](https://github.com/mur-wtag).
 
+
 ### 0.25.0 (October 31, 2016)
 
 #### Features
@@ -208,6 +251,7 @@
 * [#515](https://github.com/ruby-grape/grape-swagger/pull/515): Removes limit on model names - [@LeFnord](https://github.com/LeFnord).
 * [#511](https://github.com/ruby-grape/grape-swagger/pull/511): Fix incorrect data type linking for request params of entity types - [@serggl](https://github.com/serggl).
 
+
 ### 0.24.0 (September 23, 2016)
 
 #### Features
@@ -226,6 +270,7 @@
 * [#494](https://github.com/ruby-grape/grape-swagger/pull/494): Header parametes are now included in documentation when body parameters have been defined - [@anakinj](https://github.com/anakinj).
 * [#505](https://github.com/ruby-grape/grape-swagger/pull/505): Combines namespaces with their mounted paths to allow APIs with specified mount_paths - [@KevinLiddle](https://github.com/KevinLiddle).
 
+
 ### 0.23.0 (August 5, 2016)
 
 #### Features
@@ -241,6 +286,7 @@
 * [#479](https://github.com/ruby-grape/grape-swagger/pull/479): Fix regex for Array and Multi Type in doc_methods. Parsing of "[APoint]" should return "APoint" - [@frodrigo](https://github.com/frodrigo).
 * [#483](https://github.com/ruby-grape/grape-swagger/pull/483): Added support for nicknamed routes - [@pbendersky](https://github.com/pbendersky).
 
+
 ### 0.22.0 (July 12, 2016)
 
 #### Features
@@ -265,6 +311,7 @@
 * [#454](https://github.com/ruby-grape/grape-swagger/pull/454): Include documented Hashes in documentation output - [@aschuster3](https://github.com/aschuster3).
 * [#457](https://github.com/ruby-grape/grape-swagger/issues/457): Using camel case on namespace throws exception on add_swagger_documentation method - [@rayko](https://github.com/rayko).
 
+
 ### 0.21.0 (June 1, 2016)
 
 #### Features
@@ -280,6 +327,7 @@
 * [#420](https://github.com/ruby-grape/grape-swagger/pull/420): Raise SwaggerSpec exception if swagger spec isn't satisfied, when no parser for model is registered or response model is empty - [@Bugagazavr](https://github.com/Bugagazavr).
 * [#438](https://github.com/ruby-grape/grape-swagger/pull/438): Route version was missing in :options passed to PathString, so Endpoint.path_and_definitions_objects wasn't returning a versioned path when required - [@texpert](https://github.com/texpert).
 
+
 ### 0.20.3 (May 9, 2016)
 
 #### Features
@@ -294,6 +342,7 @@
 
 * [#399](https://github.com/ruby-grape/grape-swagger/pull/399), [#395](https://github.com/ruby-grape/grape-swagger/issues/395): Make param description optional - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.20.2 (April 22, 2016)
 
 #### Fixes
@@ -302,6 +351,7 @@
 * [#393](https://github.com/ruby-grape/grape-swagger/pull/393): Properly handle header parameters - [@wleeper](https://github.com/wleeper).
 * [#389](https://github.com/ruby-grape/grape-swagger/pull/389): Respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
 
+
 ### 0.20.1 (April 17, 2016)
 
 #### Features
@@ -313,6 +363,7 @@
 
 * [#383](https://github.com/ruby-grape/grape-swagger/pull/383): Fixed support for Grape 0.12.0 through 0.14.0 - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.20.0 (April 9, 2016)
 
 #### Features
@@ -326,10 +377,12 @@
 * [#354](https://github.com/ruby-grape/grape-swagger/pull/354): Fixed setting of `base_path` and `host`, added possibility to configure the setting of `version` and `base_path` in documented path and `operationId` - [@LeFnord](https://github.com/LeFnord).
 * [#353](https://github.com/ruby-grape/grape-swagger/pull/353), [#352](https://github.com/ruby-grape/grape-swagger/pull/353): Fixed exception with routes having a dynamic `:section` - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.10.5 (April 12, 2016)
 
 * [#344](https://github.com/ruby-grape/grape-swagger/pull/344): Namespace based tag included in Swagger JSON - [@LeFnord](https://github.com/LeFnord).
 
+
 ### 0.10.2 (August 19, 2015)
 
 #### Features
@@ -354,11 +407,13 @@
 * [#284](https://github.com/ruby-grape/grape-swagger/pull/284): Use new params syntax for swagger doc endpoint, fix an issue that `:name` params not recognized by `declared` method - [@calfzhou](https://github.com/calfzhou).
 * [#286](https://github.com/ruby-grape/grape-swagger/pull/286): Use `detail` value for `notes` - fix an issue where `detail` value specified in a block passed to `desc` was ignored - [@rngtng](https://github.com/rngtng).
 
+
 ### 0.10.1 (March 11, 2015)
 
 * [#227](https://github.com/ruby-grape/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
 * [#226](https://github.com/ruby-grape/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
 
+
 ### 0.10.0 (March 10, 2015)
 
 #### Features
@@ -378,6 +433,7 @@
 * [#208](https://github.com/ruby-grape/grape-swagger/pull/208): Fixed `Float` parameters, exposed as Swagger `float` types - [@u2](https://github.com/u2).
 * [#216](https://github.com/ruby-grape/grape-swagger/pull/216), [#192](https://github.com/ruby-grape/grape-swagger/issues/192), [#189](https://github.com/ruby-grape/grape-swagger/issues/189): Fixed API route paths matching for root endpoints with `grape ~> 0.10.0`, specific `format` and `:path` versioning - [@dm1try](https://github.com/dm1try), [@minch](https://github.com/minch).
 
+
 ### 0.9.0 (December 19, 2014)
 
 * [#91](https://github.com/ruby-grape/grape-swagger/issues/91): Fixed empty field for group parameters' name with type hash or Array - [@dukedave](https://github.com/dukedave).
@@ -392,6 +448,7 @@
 * [#167](https://github.com/ruby-grape/grape-swagger/pull/167): Support mutli-tenanted APIs, don't cache `base_path` - [@bradrobertson](https://github.com/bradrobertson), (https://github.com/dblock).
 * [#185](https://github.com/ruby-grape/grape-swagger/pull/185): Support strings in `Grape::Entity.expose`'s `:using` option - [@jhollinger](https://github.com/jhollinger).
 
+
 ### 0.8.0 (August 30, 2014)
 
 #### Features
@@ -421,6 +478,7 @@
 * Added `GrapeSwagger::VERSION` - [@dblock](https://github.com/dblock).
 * Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
 
+
 ### 0.7.2 (February 6, 2014)
 
 * [#84](https://github.com/ruby-grape/grape-swagger/pull/84): Markdown is now Github Flavored Markdown - [@jeromegn](https://github.com/jeromegn).
@@ -438,6 +496,7 @@
 * [#54](https://github.com/ruby-grape/grape-swagger/pull/54): Adding support for generating swagger `responseClass` and models from Grape Entities - [@calebwoods](https://github.com/calebwoods).
 * [#46](https://github.com/ruby-grape/grape-swagger/pull/46): Fixed translating parameter `type` to String, enables using Mongoid fields as parameter definitions - [@dblock](https://github.com/dblock).
 
+
 ### 0.6.0 (June 19, 2013)
 
 * Added Rails 4 support - [@jrhe](https://github.com/jrhe).
@@ -446,14 +505,17 @@
 * Support both `:desc` and `:description` when describing parameters - [@dblock](https://github.com/dblock).
 * Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
 
+
 ### 0.5.0 (March 28, 2013)
 
 * Added Grape 0.5.0 support - [@ruby-grape](https://github.com/ruby-grape).
 
+
 ### 0.4.0 (March 28, 2013)
 
 * Support https - [@cutalion](https://github.com/cutalion).
 
+
 ### 0.3.0 (October 19, 2012)
 
 * Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
@@ -461,24 +523,28 @@
 * Added basic support for specifying parameters that need to be passed in the header - [@agileanimal](https://github.com/agileanimal).
 * Add possibility to hide the documentation paths in the generated swagger documentation - [@ruby-grape](https://github.com/ruby-grape).
 
+
 ### 0.2.1 (August 17, 2012)
 
 * Added support for markdown in notes field - [@ruby-grape](https://github.com/ruby-grape).
 * Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
 * Fix: swagger UI history - [@ruby-grape](https://github.com/ruby-grape).
 
+
 ### 0.2.0 (July 27, 2012)
 
 * Use resource as root for swagger - [@ruby-grape](https://github.com/ruby-grape).
 * Added support for file uploads, and proper `paramType` - [@ruby-grape](https://github.com/ruby-grape).
 * Added tests - [@nathanvda](https://github.com/nathanvda).
 
+
 ### 0.1.0 (July 19, 2012)
 
 * Added some configurability to the generated documentation - [@ruby-grape](https://github.com/ruby-grape).
 * Adapted to rails plugin structure - [@ruby-grape](https://github.com/ruby-grape).
 * Allowed cross origin, so swagger can be used from official site - [@ruby-grape](https://github.com/ruby-grape).
 
+
 ### 0.0.0 (July 19, 2012)
 
 * Initial public release - [@ruby-grape](https://github.com/ruby-grape).

data/Gemfile

@@ -6,7 +6,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.2'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '< 1.3.0'
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -14,19 +14,18 @@ gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.2'
              end
 
 gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
-
 group :development, :test do
   gem 'bundler'
   gem 'grape-entity'
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
-  gem 'rack'
+
   gem 'rack-cors'
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
-  gem 'rspec', '~> 3.8'
-  gem 'rubocop', '~> 0.71', require: false
+  gem 'rspec', '~> 3.9'
+  gem 'rubocop', '~> 0.75', require: false
 end
 
 group :test do

data/README.md

@@ -48,9 +48,10 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 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.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      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -104,9 +105,9 @@ Also added support for [representable](https://github.com/apotonick/representabl
 
 ```ruby
 # For Grape::Entity ( https://github.com/ruby-grape/grape-entity )
-gem 'grape-swagger-entity'
+gem 'grape-swagger-entity', '~> 0.3'
 # For representable ( https://github.com/apotonick/representable )
-gem 'grape-swagger-representable'
+gem 'grape-swagger-representable', '~> 0.2'
 ```
 
 If you are not using Rails, make sure to load the parser inside your application initialization logic, e.g., via `require 'grape-swagger/entity'` or `require 'grape-swagger/representable'`.
@@ -189,6 +190,7 @@ end
 * [base_path](#base_path)
 * [mount_path](#mount_path)
 * [add_base_path](#add_base_path)
+* [add_root](#add_root)
 * [add_version](#add_version)
 * [doc_version](#doc_version)
 * [endpoint_auth_wrapper](#endpoint_auth_wrapper)
@@ -248,6 +250,13 @@ add_swagger_documentation \
    add_base_path: true # only if base_path given
 ```
 
+#### add_root: <a name="add_root"></a>
+Add root element to all the responses, default is: `false`.
+```ruby
+add_swagger_documentation \
+   add_root: true
+```
+
 #### add_version: <a name="add_version"></a>
 
 Add `version` key to the documented path keys, default is: `true`,
@@ -447,6 +456,7 @@ add_swagger_documentation \
 * [Extensions](#extensions)
 * [Response examples documentation](#response-examples)
 * [Response headers documentation](#response-headers)
+* [Adding root element to responses](#response-root)
 
 #### Swagger Header Parameters  <a name="headers"></a>
 
@@ -913,7 +923,7 @@ desc 'Attach a field to an entity through a PUT',
     failure: [
       { code: 400, message: 'Bad request' },
       { code: 404, message: 'Not found' }
-    ]  
+    ]
 put do
   # your code comes here
 end
@@ -1180,6 +1190,60 @@ The result will look like following:
 
 Failure information can be passed as an array of arrays or an array of hashes.
 
+#### Adding root element to responses <a name="response-root"></a>
+
+You can specify a custom root element for a successful response:
+
+```ruby
+route_setting :swagger, root: 'cute_kitten'
+desc 'Get a kitten' do
+  http_codes [{ code: 200, model: Entities::Kitten }]
+end
+get '/kittens/:id' do
+end
+```
+
+The result will look like following:
+
+```
+  "responses": {
+    "200": {
+      "description": "Get a kitten",
+      "schema": {
+        "type": "object",
+        "properties": { "cute_kitten": { "$ref": "#/definitions/Kitten" } }
+      }
+    }
+  }
+```
+
+If you specify `true`, the value of the root element will be deduced based on the model name.
+E.g. in the following example the root element will be "kittens":
+
+```ruby
+route_setting :swagger, root: true
+desc 'Get kittens' do
+  is_array true
+  http_codes [{ code: 200, model: Entities::Kitten }]
+end
+get '/kittens' do
+end
+```
+
+The result will look like following:
+
+```
+  "responses": {
+    "200": {
+      "description": "Get kittens",
+      "schema": {
+        "type": "object",
+        "properties": { "type": "array", "items": { "kittens": { "$ref": "#/definitions/Kitten" } } }
+      }
+    }
+  }
+```
+
 ## Using Grape Entities <a name="grape-entity"></a>
 
 Add the [grape-entity](https://github.com/ruby-grape/grape-entity) and [grape-swagger-entity](https://github.com/ruby-grape/grape-swagger-entity) gem to your Gemfile.

data/grape-swagger.gemspec

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

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

@@ -25,27 +25,10 @@ module GrapeSwagger
 
         def parse_entity(model)
           return unless model.respond_to?(:documentation)
-
-          deprecated_workflow_for('grape-swagger-entity')
-
-          model.documentation
-               .select { |_name, options| options[:required] }
-               .map { |name, options| options[:as] || name }
         end
 
         def parse_representable(model)
           return unless model.respond_to?(:map)
-
-          deprecated_workflow_for('grape-swagger-representable')
-
-          model.map
-               .select { |p| p[:documentation] && p[:documentation][:required] }
-               .map(&:name)
-        end
-
-        def deprecated_workflow_for(gem_name)
-          warn "DEPRECATED: You are using old #{gem_name} version, which doesn't provide " \
-            "required attributes. To solve this problem, please update #{gem_name}"
         end
       end
     end

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

@@ -87,7 +87,12 @@ module GrapeSwagger
           part.select { |x| x == identifier }
         end
 
-        def method
+        def method(*args)
+          # We're shadowing Object.method(:symbol) here so we provide
+          # a compatibility layer for code that introspects the methods
+          # of this class
+          return super if args.size.positive?
+
           @route.request_method.downcase.to_sym
         end
       end