grape-swagger 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa0c33214a157ed16d147edc9813bbb6d745498947d211c2eff21ce86b023a6
-  data.tar.gz: 27c475b099a28f9b8610ded30906edf1a974825153348d8d590abba13688f29d
+  metadata.gz: c2826417c60f2f12c57698a03f03a15b9c1603c9c19a5cfc5c6594aec5512f13
+  data.tar.gz: ed6a07977e30c0ec647f41e60acf2d0184ba8f8531c626da87213aa1136fec1b
 SHA512:
-  metadata.gz: d01c3d660f905522d943bebf2e5a609231bba1938b0cc02c49908048a691a0f0f1baa184ec2fed63d8a72280a92f3aa208273ce64b2bada90b09725cff71b080
-  data.tar.gz: 1316664cfc4ec624311e891cd5c4bc106739bc3be9cb363bac02acccaa5e282a9fc1f9012ca590313fef8b74a5d6930a0afda371c05657b271e5ddfaf9e502d4
+  metadata.gz: e032c09183d38e9ce114cb0c02f6c083a8d79339975678265ef2b6dc49945c8e977c4c2785a62f6aea0d0cc42ae72c8a6ece4cdd8d2fdb9db938eb27a819e25f
+  data.tar.gz: 42779db4d2991ddc177027f9ae4526dd6ff999faaf7abdd6a8f9cf44978878a19ce300b1440f32eaf562ca1575d1cc7f0c1a9215366eb66683d53a299767c5b0

data/.github/dependabot.yml

@@ -12,3 +12,9 @@ updates:
       day: "friday"
     assignees:
       - "LeFnord"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule: 
+      interval: weekly
+    assignees: 
+     - "LeFnord"

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+permissions:
+  contents: read
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel --format progress
+
+  rspec:
+    runs-on: ubuntu-latest
+    needs: ['rubocop']
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', 'head']
+        grape-version: [1.6.2, 1.5.3]
+        model-parser: [grape-swagger-entity, grape-swagger-representable, '']
+    steps:
+    - name: Check out branch
+      uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        GRAPE_VERSION: ${{ matrix.grape-version }}
+        MODEL_PARSER: ${{ matrix.model-parser }}
+        bundler-cache: true
+    - name: Run rspec rest of the suite
+      run: bundle exec rspec

data/.gitignore

@@ -42,3 +42,4 @@ spec/params_entity_spec.rb
 vendor/bundle/
 spec/swagger_v2/x-dummy.rb
 coverage/
+.byebug_history

data/.rspec

@@ -1 +1,3 @@
 --color
+--profile
+--format documentation

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - vendor/**/*
     - example/**/*
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   SuggestExtensions: false
 
 #  Layout stuff
@@ -101,12 +101,19 @@ Style/HashEachMethods:
 Style/HashLikeCase:
   Enabled: true
 
+Style/HashSyntax:
+  Enabled: false
+
 Style/HashTransformKeys:
   Enabled: true
 
 Style/HashTransformValues:
   Enabled: true
 
+Style/OpenStructUse:
+  Exclude:
+    - spec/**/*
+
 Style/RegexpLiteral:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,11 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-06-05 12:13:59 +0000 using RuboCop version 0.71.0.
+# on 2022-01-14 10:22:29 UTC using RuboCop version 1.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'grape-swagger.gemspec'
+
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -13,20 +21,18 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'grape-swagger.gemspec'
 
-# Offense count: 30
+# Offense count: 31
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 59
-
-# Offense count: 10
-Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 56
 
-# Offense count: 22
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 30
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 45
+  Max: 28
 
 # Offense count: 7
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
   Max: 16
 
@@ -35,6 +41,20 @@ Style/ClassVars:
   Exclude:
     - 'lib/grape-swagger/doc_methods.rb'
 
-# Offense count: 22
+# Offense count: 23
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
+
+# Offense count: 43
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/lib/endpoint_spec.rb'
+    - 'spec/lib/version_spec.rb'
+    - 'spec/support/mock_parser.rb'
+    - 'spec/support/model_parsers/mock_parser.rb'
+    - 'spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb'
+    - 'spec/swagger_v2/api_swagger_v2_mounted_spec.rb'
+    - 'spec/swagger_v2/api_swagger_v2_spec.rb'
+    - 'spec/swagger_v2/errors_spec.rb'
+    - 'spec/swagger_v2/reference_entity_spec.rb'

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### Next
+### next
 
 #### Features
 
@@ -9,6 +9,54 @@
 * Your contribution here.
 
 
+### 1.5.0 (July 28, 2022)
+
+#### Features
+
+* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
+
+#### Fixes
+
+* [#860](https://github.com/ruby-grape/grape-swagger/pull/860) chore: Included githubactions in the dependabot config [@naveensrinivasan](https://github.com/naveensrinivasan)
+* [#843](https://github.com/ruby-grape/grape-swagger/pull/843) Syntax errors in README.md examples [@remvee](https://github.com/remvee)
+* [#844](https://github.com/ruby-grape/grape-swagger/pull/844) Fixes the regexp used for parsing routes [@senhalil](https://github.com/senhalil)
+* [#847](https://github.com/ruby-grape/grape-swagger/pull/847) Parse route_param type for nested endpoints [@dmoss18](https://github.com/dmoss18)
+* [#856](https://github.com/ruby-grape/grape-swagger/pull/856) Remove unused methods in GrapeSwagger::DocMethods::BuildModelDefinition [@takahashim](https://github.com/takahashim)
+* [#858](https://github.com/ruby-grape/grape-swagger/pull/858): Set permissions for GitHub actions [@naveensrinivasan](https://github.com/naveensrinivasan)
+* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick to support Ruby 3.x [@takahashim](https://github.com/takahashim)
+* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work [@takahashim](https://github.com/takahashim)
+* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task [@Vachman](https://github.com/Vachman)
+* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of enum to be Array [@takahashim](https://github.com/takahashim)
+
+
+### 1.4.3 (January 5, 2022)
+
+#### Fixes
+
+* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of `enum` to be `Array` - [@takahashim](https://github.com/takahashim)
+* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Fixes oapi rake tasks, allows generating sepcs for different API versions.
+* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work without error - [@takahashim](https://github.com/takahashim)
+* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick gem so that example works in Ruby 3.x - [@takahashim](https://github.com/takahashim)
+* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil)
+* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
+* Your contribution here.
+
+### 1.4.2 (October 22, 2021)
+
+#### Fixes
+
+* [#840](https://github.com/ruby-grape/grape-swagger/pull/840): Fixes documentation of `additionalProperties` field when used with array parameters, or when setting it to `false` - [@magni-](https://github.com/magni-)
+* [#841](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes `type` and `format` values for object fields nested in an array ([#832](https://github.com/ruby-grape/grape-swagger/issue/832)) - [@magni-](https://github.com/magni-)
+* [#839](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes documentation of `false` or `nil` default parameter values - [@magni-](https://github.com/magni-)
+
+
+### 1.4.1 (September 15, 2021)
+
+#### Fixes
+
+* [#833](https://github.com/ruby-grape/grape-swagger/pull/833): Fixes issue of examples not showing for `in: 'body'` parameters - [@stevenou](https://github.com/stevenou)
+
+
 ### 1.4.0 (March 20, 2021)
 
 #### Features

data/CONTRIBUTING.md

@@ -115,7 +115,7 @@ git push origin my-feature-branch -f
 
 ## Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 ## Be Patient
 

data/Gemfile

@@ -6,14 +6,14 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.5.0'
+gem 'grape', case version = ENV.fetch('GRAPE_VERSION', '~> 1.6')
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
                version
              end
 
-gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
+gem ENV.fetch('MODEL_PARSER', nil) if ENV.key?('MODEL_PARSER')
 
 group :development, :test do
   gem 'bundler'
@@ -28,14 +28,17 @@ group :development, :test do
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
   gem 'rubocop', '~> 1.0', require: false
+  gem 'webrick'
 end
 
 group :test do
   gem 'coveralls_reborn', require: false
 
-  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'ruby-grape-danger', '~> 0.2.0', require: false
   gem 'simplecov', require: false
+end
 
+group :test, :development do
   unless ENV['MODEL_PARSER'] == 'grape-swagger-entity'
     gem 'grape-swagger-entity', git: 'https://github.com/ruby-grape/grape-swagger-entity'
   end

data/README.md

@@ -451,6 +451,7 @@ add_swagger_documentation \
 * [Collection Format](#collection-format)
 * [Hiding parameters](#hiding-parameters)
 * [Setting a Swagger default value](#default-value)
+* [Setting `additionalProperties` for `object`-type parameters](#additional-properties)
 * [Example parameter value](#param-example)
 * [Response documentation](#response)
 * [Changing default status codes](#change-status)
@@ -779,6 +780,36 @@ params do
 end
 ```
 
+### Setting `additionalProperties` for `object`-type parameters <a name="additional-properties">
+
+Use the `additional_properties` option in the `documentation` hash for `object`-type parameters to set [`additionalProperties`](https://swagger.io/specification/v2/#model-with-mapdictionary-properties).
+
+#### Allow any additional properties
+```ruby
+params do
+  optional :thing, type: Hash, documentation: { additional_properties: true }
+end
+```
+
+#### Allow any additional properties of a particular type
+```ruby
+params do
+  optional :thing, type: Hash, documentation: { additional_properties: String }
+end
+```
+
+#### Allow any additional properties matching a defined schema
+```ruby
+class Entity < Grape::Entity
+  expose :this
+end
+
+params do
+  optional :thing, type: Hash, documentation: { additional_properties: Entity }
+end
+```
+
+
 #### Example parameter value <a name="param-example"></a>
 
 The example parameter will populate the Swagger UI with the example value, and can be used for optional or required parameters.
@@ -786,7 +817,7 @@ The example parameter will populate the Swagger UI with the example value, and c
 ```ruby
 params do
   requires :id, type: Integer, documentation: { example: 123 }
-  optional :name, type String, documentation: { example: 'Buddy Guy' }
+  optional :name, type: String, documentation: { example: 'Buddy Guy' }
 end
 ```
 
@@ -812,7 +843,7 @@ namespace 'store/order', desc: 'Order operations within a store', swagger: { nes
   get :order_id do
   	...
   end
-  namespace 'actions', desc: 'Order actions' do, nested: false
+  namespace 'actions', desc: 'Order actions', nested: false do
     get 'evaluate' do
       ...
     end
@@ -1234,7 +1265,7 @@ end
 
 The result will look like following:
 
-```
+```json
   "responses": {
     "200": {
       "description": "Get a kitten",
@@ -1261,7 +1292,7 @@ end
 
 The result will look like following:
 
-```
+```json
   "responses": {
     "200": {
       "description": "Get kittens",
@@ -1288,7 +1319,7 @@ get '/things' do
 end
 ```
 The result will look like following:
-```
+```json
   "responses": {
     "200": {
       "description": "Multiple response",
@@ -1320,7 +1351,7 @@ get '/things' do
 end
 ```
 The result will look like following:
-```
+```json
   "responses": {
     "200": {
       "description": "Multiple response with array",
@@ -1494,7 +1525,7 @@ end
 ```
 
 Should generate this definitions:
-```JSON
+```json
 {
   "definitions": {
     "Pet": {
@@ -1687,9 +1718,10 @@ GrapeSwagger::Rake::OapiTasks.new('::Api::Base')
 ```
 rake oapi:fetch
 params:
-- store={ true | file_name } – save as JSON (optional)
+- store={ true | file_name.json } – save as JSON (optional)
 - resource=resource_name     – get only for this one (optional)
 ```
+For mutliversion API it creates several files with following naming: file_name_`API_VERSION`.json      
 
 #### OpenApi/Swagger Validation
 

data/UPGRADING.md

@@ -1,5 +1,20 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 1.5.0
+
+- The names generated for body parameter definitions and their references has changed. It'll now include the HTTP action as well as any path parameters.
+  - E.g, given a `PUT /things/:id` endpoint, `paths.things/{id}.put.parameters` in the generated Swaggerfile will contain the following:
+  - With `grape-swagger < 1.5.0`: `{ "name": "Things", ..., "schema": { "$ref": "#/definitions/putThings" } }`
+  - With `grape-swagger >= 1.5.0`: `{ "name": "putThingsId", ..., "schema": { "$ref": "#/definitions/putThingsId" } }`
+- If you use the `nickname` option for an endpoint, that nickname will be used for both the parameter name and its definition reference.
+  - E.g., if the endpoint above were nicknamed `put-thing`, the generated Swaggerfile will contain `{ "name": "put-thing", ..., "schema": { "$ref": "#/definitions/put-thing" } }`
+
+
+### Upgrading to >= 1.4.2
+
+- `additionalProperties` has been deprecated and will be removed in a future version of `grape-swagger`. It has been replaced with `additional_properties`.
+- The value of the `enum` attribute is now always an Array. If it has only one value, it will be a one-element Array.
+
 ### Upgrading to >= 1.4.0
 
 - Official support for ruby < 2.5 removed, ruby 2.5 only in testing mode, but no support.

data/example/config.ru

@@ -1,4 +1,5 @@
-require 'rack/cors'
+Bundler.require ENV['RACK_ENV']
+
 use Rack::Cors do
   allow do
     origins '*'
@@ -12,7 +13,6 @@ require './api/endpoints'
 require './api/entities'
 
 class Base < Grape::API
-  require 'grape-entity'
   require '../lib/grape-swagger'
   format :json
 

data/grape-swagger.gemspec

@@ -13,10 +13,11 @@ Gem::Specification.new do |s|
   s.summary     = 'Add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.5'
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.required_ruby_version = '>= 2.7'
   s.add_runtime_dependency 'grape', '~> 1.3'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
   s.require_paths = ['lib']
 end

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

@@ -4,14 +4,9 @@ module GrapeSwagger
   module DocMethods
     class BuildModelDefinition
       class << self
-        def build(model, properties, required, other_def_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)
-            definition[:required] = required_attrs unless required_attrs.blank?
-          end
-
           definition[:required] = required if required.is_a?(Array) && required.any?
 
           definition
@@ -67,20 +62,6 @@ module GrapeSwagger
             end
           end
         end
-
-        private
-
-        def required_attributes(model)
-          parse_entity(model) || parse_representable(model)
-        end
-
-        def parse_entity(model)
-          return unless model.respond_to?(:documentation)
-        end
-
-        def parse_representable(model)
-          return unless model.respond_to?(:map)
-        end
       end
     end
   end

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

@@ -35,6 +35,8 @@ module GrapeSwagger
 
         def add_array(parameter, related_parameters)
           related_parameters.each do |p|
+            next if p.key?(:items)
+
             p_type = p[:type] == 'array' ? 'string' : p[:type]
             p[:items] = { type: p_type, format: p[:format], enum: p[:enum], is_array: p[:is_array] }
             p[:items].delete_if { |_k, v| v.nil? }

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

@@ -38,15 +38,15 @@ module GrapeSwagger
         end
 
         def parent_definition_of_params(params, path, route)
-          definition_name = OperationId.manipulate(parse_model(path))
-          referenced_definition = build_definition(definition_name, params, route.request_method.downcase)
-          definition = @definitions[referenced_definition]
+          definition_name = OperationId.build(route, path)
+          build_definition(definition_name, params)
+          definition = @definitions[definition_name]
 
           move_params_to_new(definition, params)
 
           definition[:description] = route.description if route.try(:description)
 
-          build_body_parameter(referenced_definition, definition_name, route.options)
+          build_body_parameter(definition_name, route.options)
         end
 
         def move_params_to_new(definition, params)
@@ -103,9 +103,9 @@ module GrapeSwagger
 
         def document_as_property(param)
           property_keys.each_with_object({}) do |x, memo|
-            value = param[x]
-            next if value.blank?
+            next unless param.key?(x)
 
+            value = param[x]
             if x == :type && @definitions[value].present?
               memo['$ref'] = "#/definitions/#{value}"
             else
@@ -142,17 +142,16 @@ module GrapeSwagger
           definition[:required].push(*value)
         end
 
-        def build_body_parameter(reference, name, options)
+        def build_body_parameter(name, options)
           {}.tap do |x|
             x[:name] = options[:body_name] || name
             x[:in] = 'body'
             x[:required] = true
-            x[:schema] = { '$ref' => "#/definitions/#{reference}" }
+            x[:schema] = { '$ref' => "#/definitions/#{name}" }
           end
         end
 
-        def build_definition(name, params, verb = nil)
-          name = "#{verb}#{name}" if verb
+        def build_definition(name, params)
           @definitions[name] = should_expose_as_array?(params) ? array_type : object_type
 
           name
@@ -181,7 +180,8 @@ module GrapeSwagger
         end
 
         def property_keys
-          %i[type format description minimum maximum items enum default additionalProperties]
+          %i[type format description minimum maximum items enum default additional_properties additionalProperties
+             example]
         end
 
         def deletable?(param)
@@ -193,8 +193,7 @@ module GrapeSwagger
         end
 
         def includes_body_param?(params)
-          params.map { |x| return true if x[:in] == 'body' || x[:param_type] == 'body' }
-          false
+          params.any? { |x| x[:in] == 'body' || x[:param_type] == 'body' }
         end
 
         def should_expose_as_array?(params)
@@ -202,8 +201,7 @@ module GrapeSwagger
         end
 
         def should_exposed_as(params)
-          params.map { |x| return 'object' if x[:type] && x[:type] != 'array' }
-          'array'
+          params.any? { |x| x[:type] && x[:type] != 'array' } ? 'object' : 'array'
         end
       end
     end

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

@@ -25,7 +25,7 @@ module GrapeSwagger
           document_default_value(settings) unless value_type[:is_array]
           document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
-          document_additional_properties(settings)
+          document_additional_properties(definitions, settings) unless value_type[:is_array]
           document_add_extensions(settings)
           document_example(settings)
 
@@ -51,7 +51,7 @@ module GrapeSwagger
         end
 
         def document_default_value(settings)
-          @parsed_param[:default] = settings[:default] if settings[:default].present?
+          @parsed_param[:default] = settings[:default] if settings.key?(:default)
         end
 
         def document_type_and_format(settings, data_type)
@@ -105,12 +105,38 @@ module GrapeSwagger
 
           array_items[:default] = value_type[:default] if value_type[:default].present?
 
+          set_additional_properties, additional_properties = parse_additional_properties(definitions, value_type)
+          array_items[:additionalProperties] = additional_properties if set_additional_properties
+
           array_items
         end
 
-        def document_additional_properties(settings)
-          additional_properties = settings[:additionalProperties]
-          @parsed_param[:additionalProperties] = additional_properties if additional_properties
+        def document_additional_properties(definitions, settings)
+          set_additional_properties, additional_properties = parse_additional_properties(definitions, settings)
+          @parsed_param[:additionalProperties] = additional_properties if set_additional_properties
+        end
+
+        def parse_additional_properties(definitions, settings)
+          return false unless settings.key?(:additionalProperties) || settings.key?(:additional_properties)
+
+          value =
+            if settings.key?(:additionalProperties)
+              GrapeSwagger::Errors::SwaggerSpecDeprecated.tell!(:additionalProperties)
+              settings[:additionalProperties]
+            else
+              settings[:additional_properties]
+            end
+
+          parsed_value =
+            if definitions[value.to_s]
+              { '$ref': "#/definitions/#{value}" }
+            elsif value.is_a?(Class)
+              { type: DataType.call(value) }
+            else
+              value
+            end
+
+          [true, parsed_value]
         end
 
         def document_example(settings)
@@ -137,8 +163,10 @@ module GrapeSwagger
             parse_enum_or_range_values(values.call) if values.parameters.empty?
           when Range
             parse_range_values(values) if values.first.is_a?(Integer)
+          when Array
+            { enum: values }
           else
-            { enum: values } if values
+            { enum: [values] } if values
           end
         end