gitlab-grape-swagger 1.5.0

data/spec/issues/539_array_post_body_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#539 post params given as array' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_539 do
+        class Element < Grape::Entity
+          expose :id
+          expose :description
+          expose :role
+        end
+
+        class ArrayOfElements < Grape::Entity
+          expose :elements,
+                 documentation: {
+                   type: Element, is_array: true, param_type: 'body', required: true
+                 }
+        end
+
+        desc 'create account',
+             params: ArrayOfElements.documentation
+        post do
+          present params
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:parameters) { subject['paths']['/issue_539']['post']['parameters'] }
+  let(:definitions) { subject['definitions'] }
+
+  specify do
+    expect(parameters).to eql(
+      [
+        {
+          'in' => 'body', 'name' => 'elements', 'required' => true, 'schema' => {
+            'type' => 'array', 'items' => { '$ref' => '#/definitions/Element' }
+          }
+        }
+      ]
+    )
+  end
+
+  specify do
+    expect(definitions).to eql(
+      'Element' => {
+        'type' => 'object',
+        'properties' => {
+          'id' => { 'type' => 'string' },
+          'description' => { 'type' => 'string' },
+          'role' => { 'type' => 'string' }
+        }
+      }
+    )
+  end
+end

data/spec/issues/542_array_of_type_in_post_body_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#542 array of type in post params' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_542 do
+        params do
+          requires :logs, type: Array[String], documentation: { param_type: 'body' }
+        end
+
+        post do
+          present params
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:parameters) { subject['paths']['/issue_542']['post']['parameters'] }
+
+  specify do
+    expect(parameters).to eql(
+      [
+        {
+          'in' => 'body',
+          'name' => 'logs',
+          'required' => true,
+          'schema' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'string'
+            }
+          }
+        }
+      ]
+    )
+  end
+end

data/spec/issues/553_align_array_put_post_params_spec.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#553 array of type in post/put params' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :in_form_data do
+        desc 'create foo' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+        params do
+          requires :guid, type: Array[String]
+        end
+        post do
+          # your code goes here
+        end
+
+        desc 'put specific foo' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+        params do
+          requires :id
+          requires :guid, type: Array[String]
+        end
+        put ':id' do
+          # your code goes here
+        end
+      end
+
+      namespace :in_body do
+        desc 'create foo' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+        params do
+          requires :guid, type: Array[String], documentation: { param_type: 'body' }
+        end
+        post do
+          # your code goes here
+        end
+
+        desc 'put specific foo' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+        params do
+          requires :id
+          requires :guid, type: Array[String], documentation: { param_type: 'body' }
+        end
+        put ':id' do
+          # your code goes here
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'type for Array specified' do
+    describe 'in formData' do
+      describe 'post request' do
+        let(:params) { subject['paths']['/in_form_data']['post']['parameters'] }
+
+        specify do
+          expect(params).to eql([{
+            'in' => 'formData',
+            'name' => 'guid',
+            'type' => 'array',
+            'items' => { 'type' => 'string' },
+            'required' => true
+          }])
+        end
+      end
+
+      describe 'put request' do
+        let(:params) { subject['paths']['/in_form_data/{id}']['put']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'path',
+                'name' => 'id',
+                'type' => 'string',
+                'required' => true
+              },
+              {
+                'in' => 'formData',
+                'name' => 'guid',
+                'type' => 'array',
+                'items' => { 'type' => 'string' },
+                'required' => true
+              }
+            ]
+          )
+        end
+      end
+    end
+
+    describe 'in body' do
+      describe 'post request' do
+        let(:params) { subject['paths']['/in_body']['post']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'body',
+                'name' => 'guid',
+                'required' => true,
+                'schema' => {
+                  'type' => 'array',
+                  'items' => { 'type' => 'string' }
+                }
+              }
+            ]
+          )
+        end
+      end
+
+      describe 'put request' do
+        let(:params) { subject['paths']['/in_body/{id}']['put']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'path',
+                'name' => 'id',
+                'type' => 'string',
+                'required' => true
+              },
+              {
+                'in' => 'body',
+                'name' => 'guid',
+                'required' => true,
+                'schema' => {
+                  'type' => 'array',
+                  'items' => { 'type' => 'string' }
+                }
+              }
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/issues/572_array_post_body_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#572 is_array is applied to all possible responses' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_572 do
+        desc 'get issue',
+             is_array: true,
+             success: Entities::UseResponse,
+             failure: [
+               [401, 'BadKittenError', Entities::ApiError],
+               [404, 'NoTreatsError', Entities::ApiError],
+               [429, 'TooManyScratchesError', Entities::ApiError]
+             ]
+
+        get
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:codes) { %w[200 401 404 429] }
+
+  let(:responses) { subject['paths']['/issue_572']['get']['responses'] }
+
+  specify { expect(responses.keys.sort).to eq codes }
+
+  specify do
+    expect(responses['200']['schema']).to include 'type'
+    expect(responses['200']['schema']['type']).to eql 'array'
+  end
+
+  describe 'no array types' do
+    specify do
+      codes[1..-1].each do |code|
+        expect(responses[code]['schema']).not_to include 'type'
+        expect(responses[code]['schema'].keys).to eql ['$ref']
+      end
+    end
+  end
+end

data/spec/issues/579_align_put_post_parameters_spec.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#579 put / post parameters spec' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_579 do
+        class BodySpec < Grape::Entity
+          expose :guid, documentation: { type: String, format: 'guid', in: 'body' }
+          expose :name, documentation: { type: String, in: 'body' }
+          expose :content, documentation: { type: String, in: 'body' }
+        end
+
+        class Spec < Grape::Entity
+          expose :guid, documentation: { type: String, format: 'guid' }
+          expose :name, documentation: { type: String }
+          expose :content, documentation: { type: String }
+        end
+
+        namespace :implicit do
+          namespace :body_parameter do
+            desc 'update spec',
+              consumes: ['application/x-www-form-urlencoded'],
+              success: BodySpec,
+              params: BodySpec.documentation
+            put ':guid' do
+              # your code goes here
+            end
+          end
+
+          namespace :form_parameter do
+            desc 'update spec',
+              consumes: ['application/x-www-form-urlencoded'],
+              success: Spec,
+              params: Spec.documentation
+            put ':guid' do
+              # your code goes here
+            end
+          end
+        end
+
+        namespace :explicit do
+          namespace :body_parameter do
+            desc 'update spec',
+              consumes: ['application/x-www-form-urlencoded'],
+              success: BodySpec,
+              params: BodySpec.documentation
+            params do
+              requires :guid
+            end
+            put ':guid' do
+              # your code goes here
+            end
+          end
+
+          namespace :form_parameter do
+            desc 'update spec',
+              consumes: ['application/x-www-form-urlencoded'],
+              success: Spec,
+              params: Spec.documentation
+            params do
+              requires :guid
+            end
+            put ':guid' do
+              # your code goes here
+            end
+          end
+        end
+
+        namespace :namespace_param do
+          route_param :guid do
+            namespace :body_parameter do
+              desc 'update spec',
+                consumes: ['application/x-www-form-urlencoded'],
+                success: BodySpec,
+                params: BodySpec.documentation
+              put do
+                # your code goes here
+              end
+            end
+
+            namespace :form_parameter do
+              desc 'update spec',
+                consumes: ['application/x-www-form-urlencoded'],
+                success: Spec,
+                params: Spec.documentation
+              put do
+                # your code goes here
+              end
+            end
+          end
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'implicit path param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/implicit/body_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'putIssue579ImplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ImplicitBodyParameterGuid'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/implicit/form_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+
+  describe 'explicit path param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/explicit/body_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'putIssue579ExplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ExplicitBodyParameterGuid'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/explicit/form_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+
+  describe 'explicit as route param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/body_parameter']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'putIssue579NamespaceParamGuidBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579NamespaceParamGuidBodyParameter'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/form_parameter']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+end

data/spec/issues/582_file_response_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#582 respond with a file' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_582 do
+        desc 'produces given',
+             success: File,
+             produces: ['application/pdf', 'text/csv']
+        get '/produces_given' do
+          'responds a file'
+        end
+
+        desc 'automatic produces',
+             success: 'file'
+        get '/automatic_produces' do
+          'responds a file'
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'produces given' do
+    let(:produces) { subject['paths']['/issue_582/produces_given']['get']['produces'] }
+    let(:response) { subject['paths']['/issue_582/produces_given']['get']['responses']['200'] }
+
+    specify do
+      expect(produces).to eql ['application/pdf', 'text/csv']
+      expect(response).to include 'schema'
+      expect(response['schema']).to eql 'type' => 'file'
+    end
+  end
+
+  describe 'automatic_produces' do
+    let(:produces) { subject['paths']['/issue_582/automatic_produces']['get']['produces'] }
+    let(:response) { subject['paths']['/issue_582/automatic_produces']['get']['responses']['200'] }
+
+    specify do
+      expect(produces).to eql ['application/octet-stream']
+      expect(response).to include 'schema'
+      expect(response['schema']).to eql 'type' => 'file'
+    end
+  end
+end

data/spec/issues/587_range_parameter_delimited_by_dash_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#587 process route with parameters delimited by dash' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :range_parameter do
+        desc 'Get a array with range'
+        get '/range/:range_start-:range_end' do
+          present []
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify { expect(subject.keys).to include '/range_parameter/range/{range_start}-{range_end}' }
+  specify { expect(subject['/range_parameter/range/{range_start}-{range_end}']['get']['operationId']).to eql 'getRangeParameterRangeRangeStart-RangeEnd' }
+end

data/spec/issues/605_root_route_documentation_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 root route documentation' do
+  let(:app) do
+    Class.new(Grape::API) do
+      get do
+        { message: 'hello world' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify { expect(app.combined_routes.keys).to include '/' }
+  specify { expect(subject.keys).to include '/' }
+end

data/spec/issues/650_params_array_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 Group Params as Array' do
+  let(:app) do
+    Class.new(Grape::API) do
+      desc 'array_of_range' do
+        consumes ['application/x-www-form-urlencoded']
+      end
+      params do
+        requires :array_of_range_string, type: [String], values: %w[a b c]
+        requires :array_of_range_integer, type: [Integer], values: [1, 2, 3]
+      end
+      post '/array_of_range' do
+        { 'declared_params' => declared(params) }
+      end
+
+      desc 'array_with_default' do
+        consumes ['application/x-www-form-urlencoded']
+      end
+      params do
+        requires :array_with_default_string, type: [String], default: 'abc'
+        requires :array_with_default_integer, type: Array[Integer], default: 123
+      end
+      post '/array_with_default' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe 'retrieves the documentation for typed group range parameters' do
+    subject do
+      get '/swagger_doc/array_of_range'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_of_range']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_of_range_string', 'type' => 'array', 'items' => { 'type' => 'string', 'enum' => %w[a b c] }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_of_range_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => true }
+        ]
+      )
+    end
+  end
+
+  describe 'retrieves the documentation for typed group parameters with default' do
+    subject do
+      get '/swagger_doc/array_with_default'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_with_default']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_with_default_string', 'type' => 'array', 'items' => { 'type' => 'string', 'default' => 'abc' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_with_default_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'default' => 123 }, 'required' => true }
+        ]
+      )
+    end
+  end
+end