grape-swagger 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96f5daf8e980cca96f1dc18f0a7dad2faf86b1f3
-  data.tar.gz: 665c50fb9409756ff95f526b2a13600a37db8a40
+  metadata.gz: 1c9531be292e7a5a8d3ee086291e248f42f13457
+  data.tar.gz: 8f7cea40f42d1bb5a474f3468000c837eb540699
 SHA512:
-  metadata.gz: f4e73ba96c6060cd24e22733de9160f267d72fdd9bc73f8baf76ecb6fe31ac908dab1506171ea6a9384631140ea338768fe7452513c6fbc9eb4a81ae70bc4819
-  data.tar.gz: 6d1a9f3df56f08ade9c36f43573a669b9a3a3c1172218cd02dc885dcee3e99897500249bcc5340b6cb4bb3dabafd098a1c529bd1ebf9e07eb50a212630409bb0
+  metadata.gz: 133c28324c1637b9117e06e33e4585df7b3c072dba7432784550b1c309b24b1635abd18f97a06ce43b9c9650176a7df7bccb0a4d7ddb4cc80d61ac7ddbd067a1
+  data.tar.gz: 238698df89fbb172922f2224652eddff2fc26d89c593fb90f787bab4293def4d32bcdfd929200c7ef1770b6c33a486feb7435763bae9eb8708e83992c927cd2f

data/.rubocop_todo.yml

@@ -28,7 +28,7 @@ Metrics/AbcSize:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 220
+  Max: 226
 
 # Offense count: 10
 Metrics/CyclomaticComplexity:

data/.travis.yml

@@ -4,32 +4,32 @@ sudo: false
 
 matrix:
   include:
+    - rvm: 2.3.1
+      script:
+        - bundle exec danger
     - rvm: 2.3.1
       env: MODEL_PARSER=grape-swagger-entity
     - rvm: 2.3.1
       env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.3.1
-      env: GRAPE_VERSION=0.12.0
-    - rvm: 2.3.1
-      env: GRAPE_VERSION=0.13.0
     - rvm: 2.3.1
       env: GRAPE_VERSION=0.14.0
     - rvm: 2.3.1
       env: GRAPE_VERSION=0.15.0
     - rvm: 2.3.1
       env: GRAPE_VERSION=0.16.2
+    - rvm: 2.3.1
+      env: GRAPE_VERSION=0.17.0
     - rvm: 2.3.1
       env: GRAPE_VERSION=HEAD
     - rvm: 2.3.0
     - rvm: 2.2
     - rvm: 2.1
     - rvm: ruby-head
-    - rvm: rbx-2
-    - rvm: jruby-9.0.5.0
-    - rvm: jruby-19mode
+    - rvm: jruby-9.1.2.0
     - rvm: jruby-head
+    - rvm: rbx-2
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-2
-    - rvm: jruby-19mode
+    - rvm: jruby-9.1.2.0
     - rvm: jruby-head
+    - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,21 @@
 
 * Your contribution here.
 
+### 0.23.0 (August 5, 2016)
+
+#### Features
+
+* [#491](https://github.com/ruby-grape/grape/pull/491): Add `ignore_defaults` option - [@pezholio](https://github.com/pezholio).
+* [#486](https://github.com/ruby-grape/grape/pull/486): Use an automated PR linter, [danger.systems](http://danger.systems) - [@dblock](https://github.com/dblock).
+
+#### Fixes
+
+* [#489](https://github.com/ruby-grape/grape-swagger/pull/489): Makes version settings/usage more clear; updates `UPGRADE.md`, `README.md` - [@LeFnord](https://github.com/LeFnord).
+* [#476](https://github.com/ruby-grape/grape-swagger/pull/476): Fixes for handling the parameter type when body parameters are defined inside desc block - [@anakinj](https://github.com/anakinj).
+* [#478](https://github.com/ruby-grape/grape-swagger/pull/478): Refactors building of properties, corrects documentation of array items - [@LeFnord](https://github.com/LeFnord).
+* [#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
@@ -27,10 +42,10 @@
 * [#455](https://github.com/ruby-grape/grape-swagger/pull/455): Setting `type:` option as `Array[Class]` creates `array` type in JSON - [@tyspring](https://github.com/tyspring).
 * [#450](https://github.com/ruby-grape/grape-swagger/pull/438): Do not add :description to definitions if :description is missing on path - [@texpert](https://github.com/texpert).
 * [#447](https://github.com/ruby-grape/grape-swagger/pull/447): Version part of the url is now ignored when generating tags for endpoint - [@anakinj](https://github.com/anakinj).
-* [#444](https://github.com/ruby-grape/grape-swagger//pull/444): Default value provided in the documentation hash, override the grape default [@scauglog](https://github.com/scauglog).
-* [#443](https://github.com/ruby-grape/grape-swagger/issues/443): Type provided in the documentation hash, override the grape type [@scauglog](https://github.com/scauglog).
+* [#444](https://github.com/ruby-grape/grape-swagger/pull/444): Default value provided in the documentation hash, override the grape default - [@scauglog](https://github.com/scauglog).
+* [#443](https://github.com/ruby-grape/grape-swagger/issues/443): Type provided in the documentation hash, override the grape type - [@scauglog](https://github.com/scauglog).
 * [#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/).
+* [#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)
 
@@ -167,7 +182,7 @@
 * [#136](https://github.com/ruby-grape/grape-swagger/pull/136), [#94](https://github.com/ruby-grape/grape-swagger/pull/94): Recurse combination of namespaces when using mounted apps - [@renier](https://github.com/renier).
 * [#100](https://github.com/ruby-grape/grape-swagger/pull/100): Added ability to specify a nickname for an endpoint - [@lhorne](https://github.com/lhorne).
 * [#94](https://github.com/ruby-grape/grape-swagger/pull/94): Added support for namespace descriptions - [@renier](https://github.com/renier).
-* [#110](https://github.com/ruby-grape/grape-swagger/pull/110), [#111](https://github.com/ruby-grape/grape-swagger/pull/111) - Added `responseModel` support - [@bagilevi](https://github.com/bagilevi).
+* [#110](https://github.com/ruby-grape/grape-swagger/pull/110), [#111](https://github.com/ruby-grape/grape-swagger/pull/111): Added `responseModel` support - [@bagilevi](https://github.com/bagilevi).
 * [#114](https://github.com/ruby-grape/grape-swagger/pull/114): Added support for generating nested models from composed Grape Entities - [@dspaeth-faber](https://github.com/dspaeth-faber).
 * [#124](https://github.com/ruby-grape/grape-swagger/pull/124): Added ability to change the description and parameters of the API endpoints generated by grape-swagger - [@dblock](https://github.com/dblock).
 * [#128](https://github.com/ruby-grape/grape-swagger/pull/128): Combine global models and endpoint entities - [@dspaeth-faber](https://github.com/dspaeth-faber).

data/Dangerfile

@@ -0,0 +1 @@
+# inherits from https://github.com/ruby-grape/danger

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gemspec
 
-case version = ENV['GRAPE_VERSION'] || '~> 0.16.2'
+case version = ENV['GRAPE_VERSION'] || '~> 0.17.0'
 when 'HEAD'
   gem 'grape', github: 'ruby-grape/grape'
 else
@@ -15,3 +15,5 @@ if RUBY_VERSION < '2.2.2'
   gem 'rack', '<2.0.0'
   gem 'activesupport', '<5.0.0'
 end
+
+gem 'danger', '~> 2.1', require: false

data/README.md

@@ -199,8 +199,7 @@ end
 
 
 You can pass a hash with optional configuration settings to ```add_swagger_documentation```.
-
-*not all configuration options supported yet*, but is WIP
+The examples shows the default value.
 
 
 The `host` and `base_path` options also accept a `proc` or `lambda` to evaluate, which is passed a [request](http://www.rubydoc.info/github/rack/rack/Rack/Request) object:
@@ -223,7 +222,7 @@ add_swagger_documentation \
 Base path of the API that's being exposed, default would be taken from `request`.
 ```ruby
 add_swagger_documentation \
-   base_path: '/super/api'
+   base_path: nil
 ```
 
 `host` and `base_path` are also accepting a `proc` or `lambda`
@@ -233,14 +232,14 @@ add_swagger_documentation \
 The path where the API documentation is loaded, default is: `/swagger_doc`.
 ```ruby
 add_swagger_documentation \
-   mount_path: '/docu'
+   mount_path: '/swagger_doc'
 ```
 
 #### add_base_path:
 Add `basePath` key to the documented path keys, default is: `false`.
 ```ruby
 add_swagger_documentation \
-   add_base_path: true
+   add_base_path: true # only if base_path given
 ```
 
 #### add_version:
@@ -249,7 +248,7 @@ here the version is the API version, specified by `grape` in [`path`](https://gi
 
 ```ruby
 add_swagger_documentation \
-   add_version: false
+   add_version: true
 ```
 
 <a name="doc_version" />
@@ -289,9 +288,6 @@ add_swagger_documentation \
   }
 ```
 
-#### *authorizations*:
-This value is added to the `authorizations` key in the JSON documentation.
-
 <a name="models" />
 #### models:
 A list of entities to document. Combine with the [grape-entity](https://github.com/ruby-grape/grape-entity) gem.
@@ -333,6 +329,8 @@ add_swagger_documentation \
 
 A hash merged into the `info` key of the JSON documentation.
 
+<!-- #### *authorizations*:
+This value is added to the `authorizations` key in the JSON documentation. -->
 
 <!-- #### *api_documentation*:
 Customize the Swagger API documentation route, typically contains a `desc` field. The default description is "Swagger compatible API description".

data/UPGRADING.md

@@ -10,6 +10,22 @@ gem 'grape-swagger'
 gem 'grape-swagger-entity'
 ```
 
+`add_swagger_documentation` has changed from
+``` ruby
+  add_swagger_documentation \
+    api_version: '0.0.1'
+```
+to
+
+``` ruby
+  add_swagger_documentation \
+    doc_version: '0.0.1'
+```
+
+The API version self, would be set by grape, see -> [spec for #403](https://github.com/ruby-grape/grape-swagger/blob/master/spec/issues/403_versions_spec.rb).
+
+
+
 ### Upgrading to >= 0.10.2
 
 With grape >= 0.12.0, support for `notes` is replaced by passing a block `detail` option specified. For future compatibility, update your code:

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

@@ -32,7 +32,7 @@ module GrapeSwagger
         def parse_multi_type(raw_data_type)
           case raw_data_type
           when /\A\[.*\]\z/
-            raw_data_type.gsub(/[(\A\[)(\s+)(\]\z)]/, '').split(',').first
+            raw_data_type.gsub(/[\[\s+\]]/, '').split(',').first
           when Array
             raw_data_type.first
           else

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

@@ -33,7 +33,7 @@ module GrapeSwagger
         end
 
         def move_params_to_new(definition, params)
-          params, nested_params = params.partition { |x| !x[:name].include?('[') }
+          params, nested_params = params.partition { |x| !x[:name].to_s.include?('[') }
 
           unless params.blank?
             properties, required = build_properties(params)
@@ -44,6 +44,39 @@ module GrapeSwagger
           add_properties_to_definition(definition, nested_properties, []) unless nested_params.blank?
         end
 
+        def build_properties(params)
+          properties = {}
+          required = []
+
+          prepare_nested_types(params) if should_expose_as_array?(params)
+
+          params.each do |param|
+            name = param[:name].to_sym
+
+            properties[name] = if should_expose_as_array?([param])
+                                 document_as_array(param)
+                               else
+                                 document_as_property(param)
+                               end
+
+            required << name if deletable?(param) && param[:required]
+          end
+
+          [properties, required]
+        end
+
+        def document_as_array(param)
+          {}.tap do |property|
+            property[:type] = 'array'
+            property[:description] = param.delete(:description) unless param[:description].nil?
+            property[:items] = document_as_property(param)[:items]
+          end
+        end
+
+        def document_as_property(param)
+          property_keys.each_with_object({}) { |x, memo| memo[x] = param[x] if param[x].present? }
+        end
+
         def build_nested_properties(params, properties = {})
           property = params.bsearch { |x| x[:name].include?('[') }[:name].split('[').first
 
@@ -94,41 +127,6 @@ module GrapeSwagger
           definition[:required].push(*value)
         end
 
-        def build_properties(params)
-          properties = {}
-          required = []
-
-          prepare_nested_types(params) if should_expose_as_array?(params)
-
-          params.each do |param|
-            name = param[:name].to_sym
-            properties[name] = {}
-
-            if should_expose_as_array?([param])
-              prepare_nested_types([param])
-
-              properties[name][:type] = 'array'
-              properties[name][:items] = {}
-              properties[name][:items].tap do |x|
-                property_keys.each do |attribute|
-                  x[attribute] = param[attribute] unless param[attribute].nil?
-                end
-              end
-            else
-
-              properties[name].tap do |x|
-                property_keys.each do |attribute|
-                  x[attribute] = param[attribute] unless param[attribute].nil?
-                end
-              end
-            end
-
-            required << name if deletable?(param) && param[:required]
-          end
-
-          [properties, required]
-        end
-
         def build_body_parameter(reference, name)
           {}.tap do |x|
             x[:name] = name

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

@@ -3,11 +3,17 @@ module GrapeSwagger
     class OperationId
       class << self
         def build(route, path = nil)
-          verb = route.request_method.to_s.downcase
+          if route.options[:nickname]
+            operation_id = route.options[:nickname]
+          else
+            verb = route.request_method.to_s.downcase
 
-          operation = manipulate(path) unless path.nil?
+            operation = manipulate(path) unless path.nil?
 
-          "#{verb}#{operation}"
+            operation_id = "#{verb}#{operation}"
+          end
+
+          operation_id
         end
 
         def manipulate(path)

data/lib/grape-swagger/endpoint.rb

@@ -168,11 +168,9 @@ module Grape
     end
 
     def response_object(route, markdown)
-      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
-      default_code[:model] = @entity if @entity
-      default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      codes = (route.http_codes || route.options[:failure] || [])
+      codes = apply_defaults(route, codes) if route.options[:ignore_defaults].nil?
 
-      codes = [default_code] + (route.http_codes || route.options[:failure] || [])
       codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2] } : x }
 
       codes.each_with_object({}) do |value, memo|
@@ -200,6 +198,13 @@ module Grape
       end
     end
 
+    def apply_defaults(route, codes)
+      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
+      default_code[:model] = @entity if @entity
+      default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      [default_code] + codes
+    end
+
     def tag_object(route)
       Array(route.path.split('{')[0].split('/').reject(&:empty?).delete_if { |i| ((i == route.prefix.to_s) || (i == route.version)) }.first)
     end
@@ -231,9 +236,11 @@ module Grape
       array_key = nil
       params.select { |param| public_parameter?(param) }.each_with_object({}) do |param, memo|
         name, options = *param
-        array_key = name.to_s if param_type_is_array?(options[:type])
+        param_type = options[:type]
+        param_type = param_type.to_s unless param_type.nil?
+        array_key = name.to_s if param_type_is_array?(param_type)
         options[:is_array] = true if array_key && name.start_with?(array_key)
-        memo[param.first] = options unless (options[:type] == 'Hash' || options[:type] == 'Array') && !options.key?(:documentation)
+        memo[name] = options unless %w(Hash Array).include?(param_type) && !options.key?(:documentation)
       end
     end
 

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

data/spec/issues/403_versions_spec.rb

@@ -16,31 +16,12 @@ describe 'describing versions' do
 
     subject do
       get '/swagger_doc'
-      JSON.parse(last_response.body, symbolize_names: true)
+      JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject).to eql(
-        info: { title: 'API title', version: '0.0.1' },
-        swagger: '2.0',
-        produces: ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        host: 'example.org',
-        tags: [{ name: 'nothings', description: 'Operations about nothings' }],
-        paths: {
-          :'/nothings' => {
-            get: {
-              summary: 'no versions given',
-              description: 'no versions given',
-              produces: ['application/json'],
-              responses: {
-                :'200' => { description: 'no versions given' }
-              },
-              tags: ['nothings'],
-              operationId: 'getNothings'
-            }
-          }
-        }
-      )
+      expect(subject['info']['version']).to eql '0.0.1'
+      expect(subject['paths'].keys.first).to eql '/nothings'
     end
   end
 
@@ -59,31 +40,12 @@ describe 'describing versions' do
 
     subject do
       get '/v2/swagger_doc'
-      JSON.parse(last_response.body, symbolize_names: true)
+      JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject).to eql(
-        info: { title: 'API title', version: '0.0.1' },
-        swagger: '2.0',
-        produces: ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        host: 'example.org',
-        tags: [{ name: 'api_version', description: 'Operations about api_versions' }],
-        paths: {
-          :'/v2/api_version' => {
-            get: {
-              summary: 'api versions given',
-              description: 'api versions given',
-              produces: ['application/json'],
-              responses: {
-                :'200' => { description: 'api versions given' }
-              },
-              tags: ['api_version'],
-              operationId: 'getV2ApiVersion'
-            }
-          }
-        }
-      )
+      expect(subject['info']['version']).to eql '0.0.1'
+      expect(subject['paths'].keys.first).to eql '/v2/api_version'
     end
   end
 
@@ -95,80 +57,67 @@ describe 'describing versions' do
           { message: 'hello world …' }
         end
 
-        add_swagger_documentation doc_version: '0.0.2'
+        add_swagger_documentation doc_version: '0.1'
       end
     end
 
     subject do
       get '/swagger_doc'
-      JSON.parse(last_response.body, symbolize_names: true)
+      JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject).to eql(
-        info: { title: 'API title', version: '0.0.2' },
-        swagger: '2.0',
-        produces: ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        host: 'example.org',
-        tags: [{ name: 'doc_version', description: 'Operations about doc_versions' }],
-        paths: {
-          :'/doc_version' => {
-            get: {
-              summary: 'doc versions given',
-              description: 'doc versions given',
-              produces: ['application/json'],
-              responses: {
-                :'200' => { description: 'doc versions given' }
-              },
-              tags: ['doc_version'],
-              operationId: 'getDocVersion'
-            }
-          }
-        }
-      )
+      expect(subject['info']['version']).to eql '0.1'
+      expect(subject['paths'].keys.first).to eql '/doc_version'
     end
   end
 
   describe 'both versions given' do
     def app
       Class.new(Grape::API) do
-        version :v2, using: :path
+        version :v3, using: :path
         desc 'both versions given'
         get '/both_versions' do
           { message: 'hello world …' }
         end
 
-        add_swagger_documentation doc_version: '0.0.2'
+        add_swagger_documentation doc_version: '0.2'
       end
     end
 
     subject do
-      get '/v2/swagger_doc'
-      JSON.parse(last_response.body, symbolize_names: true)
+      get '/v3/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['info']['version']).to eql '0.2'
+      expect(subject['paths'].keys.first).to eql '/v3/both_versions'
+    end
+  end
+
+  describe 'try to override grape given version' do
+    def app
+      Class.new(Grape::API) do
+        version :v4, using: :path
+        desc 'overriding grape given version?'
+        get '/grape_version' do
+          { message: 'hello world …' }
+        end
+
+        add_swagger_documentation doc_version: '0.0.3',
+                                  version: 'v5'
+      end
+    end
+
+    subject do
+      get '/v4/swagger_doc'
+      JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject).to eql(
-        info: { title: 'API title', version: '0.0.2' },
-        swagger: '2.0',
-        produces: ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        host: 'example.org',
-        tags: [{ name: 'both_versions', description: 'Operations about both_versions' }],
-        paths: {
-          :'/v2/both_versions' => {
-            get: {
-              summary: 'both versions given',
-              description: 'both versions given',
-              produces: ['application/json'],
-              responses: {
-                :'200' => { description: 'both versions given' }
-              },
-              tags: ['both_versions'],
-              operationId: 'getV2BothVersions'
-            }
-          }
-        }
-      )
+      expect(subject['info']['version']).to eql '0.0.3'
+      expect(subject['paths'].keys.first).to eql '/v4/grape_version'
     end
   end
 end

data/spec/lib/data_type_spec.rb

@@ -24,6 +24,12 @@ describe GrapeSwagger::DocMethods::DataType do
     it { expect(subject).to eql 'string' }
   end
 
+  describe 'Multi types in a string stating with A' do
+    let(:value) { { type: '[Apple, Orange]' } }
+
+    it { expect(subject).to eql 'Apple' }
+  end
+
   describe 'Multi types in array' do
     let(:value) { { type: [String, Integer] } }
 

data/spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'body parameter definitions' do
+  before :all do
+    module TheBodyApi
+      class Endpoint < Grape::API
+        resource :endpoint do
+          desc 'The endpoint' do
+            headers XAuthToken: {
+              description: 'Valdates your identity',
+              required: true
+            }
+            params body_param: { type: 'String', desc: 'param', documentation: { in: 'body' } },
+                   body_type_as_const_param: { type: String, desc: 'string_param', documentation: { in: 'body' } }
+          end
+
+          post do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheBodyApi::Endpoint
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  context 'a definition is generated for the endpoints parameters defined within the desc block' do
+    specify do
+      expect(subject['definitions']['postEndpoint']['properties']).to eql(
+        'body_param' => { 'type' => 'string', 'description' => 'param' },
+        'body_type_as_const_param' => { 'type' => 'string', 'description' => 'string_param' }
+      )
+    end
+  end
+end

data/spec/swagger_v2/api_swagger_v2_ignore_defaults_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'swagger spec v2.0' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      desc 'This creates Thing after a delay',
+           success: Entities::Something
+      params do
+        requires :text, type: String, documentation: { type: 'string', desc: 'Content of something.' }
+        requires :links, type: Array, documentation: { type: 'link', is_array: true }
+      end
+      post '/delay_thing', http_codes: [{ code: 202, message: 'OK' }], ignore_defaults: true do
+        status 202
+      end
+
+      version 'v3', using: :path
+      add_swagger_documentation api_version: 'v1',
+                                base_path: '/api',
+                                info: {
+                                  title: 'The API title to be displayed on the API homepage.',
+                                  description: 'A description of the API.',
+                                  contact_name: 'Contact name',
+                                  contact_email: 'Contact@email.com',
+                                  contact_url: 'Contact URL',
+                                  license: 'The name of the license.',
+                                  license_url: 'www.The-URL-of-the-license.org',
+                                  terms_of_service_url: 'www.The-URL-of-the-terms-and-service.com'
+                                }
+    end
+  end
+
+  before do
+    get '/v3/swagger_doc'
+  end
+
+  let(:json) { JSON.parse(last_response.body) }
+
+  it 'only returns one response if ignore_defaults is specified' do
+    expect(json['paths']['/delay_thing']['post']['responses']).to eq('202' => { 'description' => 'OK' })
+    expect(json['paths']['/delay_thing']['post']['responses'].keys).not_to include '201'
+  end
+end

data/spec/swagger_v2/nicknamed_api_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'a nicknamed mounted api' do
+  def app
+    Class.new(Grape::API) do
+      desc 'Show this endpoint', nickname: 'simple'
+      get '/simple' do
+        { foo: 'bar' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc.json'
+    JSON.parse(last_response.body)
+  end
+
+  it 'uses the nickname as the operationId' do
+    expect(subject['paths']['/simple']['get']['operationId']).to eql('simple')
+  end
+end

data/spec/swagger_v2/params_array_spec.rb

@@ -128,8 +128,10 @@ describe 'Group Params as Array' do
       expect(subject['definitions']['postObjectAndArray']['type']).to eql 'object'
       expect(subject['definitions']['postObjectAndArray']['properties']).to eql(
         'array_of_string' => {
-          'type' => 'array', 'items' => {
-            'type' => 'string', 'description' => 'array of strings'
+          'type' => 'array',
+          'description' => 'array of strings',
+          'items' => {
+            'type' => 'string'
           }
         },
         'integer_value' => {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -222,6 +222,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -276,6 +277,7 @@ files:
 - spec/support/model_parsers/representable_parser.rb
 - spec/support/namespace_tags.rb
 - spec/support/the_paths_definitions.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
@@ -285,6 +287,7 @@ files:
 - 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
@@ -307,6 +310,7 @@ files:
 - 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/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb
@@ -363,6 +367,7 @@ test_files:
 - spec/support/model_parsers/representable_parser.rb
 - spec/support/namespace_tags.rb
 - spec/support/the_paths_definitions.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
@@ -372,6 +377,7 @@ test_files:
 - 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
@@ -394,6 +400,7 @@ test_files:
 - 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/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb