grape-swagger 1.6.0 → 2.0.0

data/spec/swagger_v2/params_array_collection_format_spec.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'Group Array Params, using collection format' do
-  def app
-    Class.new(Grape::API) do
-      format :json
-
-      params do
-        optional :array_of_strings, type: Array[String], desc: 'array in csv collection format'
-      end
-
-      get '/array_of_strings_without_collection_format' do
-        { 'declared_params' => declared(params) }
-      end
-
-      params do
-        optional :array_of_strings, type: Array[String], desc: 'array in multi collection format', documentation: { collectionFormat: 'multi' }
-      end
-
-      get '/array_of_strings_multi_collection_format' do
-        { 'declared_params' => declared(params) }
-      end
-
-      params do
-        optional :array_of_strings, type: Array[String], documentation: { collectionFormat: 'foo' }
-      end
-
-      get '/array_of_strings_invalid_collection_format' do
-        { 'declared_params' => declared(params) }
-      end
-
-      params do
-        optional :array_of_strings, type: Array[String], desc: 'array in brackets collection format', documentation: { collectionFormat: 'brackets' }
-      end
-
-      get '/array_of_strings_brackets_collection_format' do
-        { 'declared_params' => declared(params) }
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  describe 'documentation for array parameter in default csv collectionFormat' do
-    subject do
-      get '/swagger_doc/array_of_strings_without_collection_format'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_of_strings_without_collection_format']['get']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_of_strings', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false, 'description' => 'array in csv collection format' }
-        ]
-      )
-    end
-  end
-
-  describe 'documentation for array parameters in multi collectionFormat set from documentation' do
-    subject do
-      get '/swagger_doc/array_of_strings_multi_collection_format'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_of_strings_multi_collection_format']['get']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_of_strings', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false, 'collectionFormat' => 'multi', 'description' => 'array in multi collection format' }
-        ]
-      )
-    end
-  end
-
-  describe 'documentation for array parameters in brackets collectionFormat set from documentation' do
-    subject do
-      get '/swagger_doc/array_of_strings_brackets_collection_format'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_of_strings_brackets_collection_format']['get']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_of_strings', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false, 'collectionFormat' => 'brackets', 'description' => 'array in brackets collection format' }
-        ]
-      )
-    end
-  end
-
-  describe 'documentation for array parameters with collectionFormat set to invalid option' do
-    subject do
-      get '/swagger_doc/array_of_strings_invalid_collection_format'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_of_strings_invalid_collection_format']['get']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_of_strings', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false }
-        ]
-      )
-    end
-  end
-end

data/spec/swagger_v2/params_array_spec.rb

@@ -1,203 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'Group Params as Array' do
-  include_context "#{MODEL_PARSER} swagger example"
-
-  [true, false].each do |array_use_braces|
-    context "when array_use_braces option is set to #{array_use_braces}" do
-      let(:braces) { array_use_braces ? '[]' : '' }
-
-      let(:app) do
-        Class.new(Grape::API) do
-          format :json
-
-          params do
-            requires :required_group, type: Array do
-              requires :required_param_1
-              requires :required_param_2
-            end
-          end
-          post '/groups' do
-            { 'declared_params' => declared(params) }
-          end
-
-          params do
-            requires :typed_group, type: Array do
-              requires :id, type: Integer, desc: 'integer given'
-              requires :name, type: String, desc: 'string given'
-              optional :email, type: String, desc: 'email given'
-              optional :others, type: Integer, values: [1, 2, 3]
-            end
-          end
-          post '/type_given' do
-            { 'declared_params' => declared(params) }
-          end
-
-          # as body parameters it would be interpreted a bit different,
-          # cause it could not be distinguished anymore, so this would be translated to one array,
-          # see also next example for the difference
-          params do
-            requires :array_of_string, type: Array[String], documentation: { param_type: 'body', desc: 'nested array of strings' }
-            requires :array_of_integer, type: Array[Integer], documentation: { param_type: 'body', desc: 'nested array of integers' }
-          end
-
-          post '/array_of_type' do
-            { 'declared_params' => declared(params) }
-          end
-
-          params do
-            requires :array_of_string, type: Array[String], documentation: { param_type: 'body', desc: 'array of strings' }
-            requires :integer_value, type: Integer, documentation: { param_type: 'body', desc: 'integer value' }
-          end
-
-          post '/object_and_array' do
-            { 'declared_params' => declared(params) }
-          end
-
-          params do
-            requires :array_of_string, type: Array[String]
-            requires :array_of_integer, type: Array[Integer]
-          end
-
-          post '/array_of_type_in_form' do
-            { 'declared_params' => declared(params) }
-          end
-
-          params do
-            requires :array_of_entities, type: Array[Entities::ApiError]
-          end
-
-          post '/array_of_entities' do
-            { 'declared_params' => declared(params) }
-          end
-
-          add_swagger_documentation array_use_braces: array_use_braces
-        end
-      end
-
-      describe 'retrieves the documentation for grouped parameters' do
-        subject do
-          get '/swagger_doc/groups'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['paths']['/groups']['post']['parameters']).to eql(
-            [
-              { 'in' => 'formData', 'name' => "required_group#{braces}[required_param_1]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-              { 'in' => 'formData', 'name' => "required_group#{braces}[required_param_2]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
-            ]
-          )
-        end
-      end
-
-      describe 'retrieves the documentation for typed group parameters' do
-        subject do
-          get '/swagger_doc/type_given'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['paths']['/type_given']['post']['parameters']).to eql(
-            [
-              { 'in' => 'formData', 'name' => "typed_group#{braces}[id]", 'description' => 'integer given', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true },
-              { 'in' => 'formData', 'name' => "typed_group#{braces}[name]", 'description' => 'string given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
-              { 'in' => 'formData', 'name' => "typed_group#{braces}[email]", 'description' => 'email given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false },
-              { 'in' => 'formData', 'name' => "typed_group#{braces}[others]", 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => false }
-            ]
-          )
-        end
-      end
-
-      describe 'retrieves the documentation for parameters that are arrays of primitive types' do
-        subject do
-          get '/swagger_doc/array_of_type'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['definitions']['postArrayOfType']['type']).to eql 'array'
-          expect(subject['definitions']['postArrayOfType']['items']).to eql(
-            'type' => 'object',
-            'properties' => {
-              'array_of_string' => {
-                'items' => { 'type' => 'string' }, 'type' => 'array', 'description' => 'nested array of strings'
-              },
-              'array_of_integer' => {
-                'items' => { 'type' => 'integer', 'format' => 'int32' }, 'type' => 'array', 'description' => 'nested array of integers'
-              }
-            },
-            'required' => %w[array_of_string array_of_integer]
-          )
-        end
-      end
-
-      describe 'documentation for simple and array parameters' do
-        subject do
-          get '/swagger_doc/object_and_array'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['definitions']['postObjectAndArray']['type']).to eql 'object'
-          expect(subject['definitions']['postObjectAndArray']['properties']).to eql(
-            'array_of_string' => {
-              'type' => 'array',
-              'description' => 'array of strings',
-              'items' => {
-                'type' => 'string'
-              }
-            },
-            'integer_value' => {
-              'type' => 'integer', 'format' => 'int32', 'description' => 'integer value'
-            }
-          )
-        end
-      end
-
-      describe 'retrieves the documentation for typed group parameters' do
-        subject do
-          get '/swagger_doc/array_of_type_in_form'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['paths']['/array_of_type_in_form']['post']['parameters']).to eql(
-            [
-              { 'in' => 'formData', 'name' => "array_of_string#{braces}", 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
-              { 'in' => 'formData', 'name' => "array_of_integer#{braces}", 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true }
-            ]
-          )
-        end
-      end
-
-      describe 'documentation for entity array parameters' do
-        let(:parameters) do
-          [
-            {
-              'in' => 'formData',
-              'name' => "array_of_entities#{braces}",
-              'type' => 'array',
-              'items' => {
-                '$ref' => '#/definitions/ApiError'
-              },
-              'required' => true
-            }
-          ]
-        end
-
-        subject do
-          get '/swagger_doc/array_of_entities'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['definitions']['ApiError']).not_to be_blank
-          expect(subject['paths']['/array_of_entities']['post']['parameters']).to eql(parameters)
-        end
-      end
-    end
-  end
-end

data/spec/swagger_v2/params_example_spec.rb

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

data/spec/swagger_v2/params_hash_spec.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'Group Params as Hash' do
-  def app
-    Class.new(Grape::API) do
-      format :json
-
-      params do
-        requires :required_group, type: Hash do
-          requires :required_param_1
-          requires :required_param_2
-        end
-      end
-      post '/use_groups' do
-        { 'declared_params' => declared(params) }
-      end
-
-      params do
-        requires :typed_group, type: Hash do
-          requires :id, type: Integer, desc: 'integer given'
-          requires :name, type: String, desc: 'string given'
-          optional :email, type: String, desc: 'email given'
-          optional :others, type: Integer, values: [1, 2, 3]
-        end
-      end
-      post '/use_given_type' do
-        { 'declared_params' => declared(params) }
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  describe 'grouped parameters' do
-    subject do
-      get '/swagger_doc/use_groups'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/use_groups']['post']).to include('parameters')
-      expect(subject['paths']['/use_groups']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'required_group[required_param_1]', 'type' => 'string', 'required' => true },
-          { 'in' => 'formData', 'name' => 'required_group[required_param_2]', 'type' => 'string', 'required' => true }
-        ]
-      )
-    end
-  end
-
-  describe 'grouped parameters with given type' do
-    subject do
-      get '/swagger_doc/use_given_type'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/use_given_type']['post']).to include('parameters')
-      expect(subject['paths']['/use_given_type']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'typed_group[id]', 'description' => 'integer given', 'type' => 'integer', 'required' => true, 'format' => 'int32' },
-          { 'in' => 'formData', 'name' => 'typed_group[name]', 'description' => 'string given', 'type' => 'string', 'required' => true },
-          { 'in' => 'formData', 'name' => 'typed_group[email]', 'description' => 'email given', 'type' => 'string', 'required' => false },
-          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'integer', 'required' => false, 'format' => 'int32', 'enum' => [1, 2, 3] }
-        ]
-      )
-    end
-  end
-end

data/spec/swagger_v2/params_nested_spec.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'nested group params' do
-  [true, false].each do |array_use_braces|
-    context "when array_use_braces option is set to #{array_use_braces}" do
-      let(:braces) { array_use_braces ? '[]' : '' }
-      let(:app) do
-        Class.new(Grape::API) do
-          format :json
-
-          params do
-            requires :a_array, type: Array do
-              requires :param_1, type: Integer
-              requires :b_array, type: Array do
-                requires :param_2, type: String
-              end
-              requires :c_hash, type: Hash do
-                requires :param_3, type: String
-              end
-            end
-            requires :a_array_foo, type: String
-          end
-          post '/nested_array' do
-            { 'declared_params' => declared(params) }
-          end
-
-          params do
-            requires :a_hash, type: Hash do
-              requires :param_1, type: Integer
-              requires :b_hash, type: Hash do
-                requires :param_2, type: String
-              end
-              requires :c_array, type: Array do
-                requires :param_3, type: String
-              end
-            end
-            requires :a_hash_foo, type: String
-          end
-          post '/nested_hash' do
-            { 'declared_params' => declared(params) }
-          end
-
-          add_swagger_documentation array_use_braces: array_use_braces
-        end
-      end
-
-      describe 'retrieves the documentation for nested array parameters' do
-        subject do
-          get '/swagger_doc/nested_array'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['paths']['/nested_array']['post']['parameters']).to eql(
-            [
-              { 'in' => 'formData', 'name' => "a_array#{braces}[param_1]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' } },
-              { 'in' => 'formData', 'name' => "a_array#{braces}[b_array]#{braces}[param_2]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-              { 'in' => 'formData', 'name' => "a_array#{braces}[c_hash][param_3]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-              { 'in' => 'formData', 'name' => 'a_array_foo', 'required' => true, 'type' => 'string' }
-            ]
-          )
-        end
-      end
-
-      describe 'retrieves the documentation for nested hash parameters' do
-        subject do
-          get '/swagger_doc/nested_hash'
-          JSON.parse(last_response.body)
-        end
-
-        specify do
-          expect(subject['paths']['/nested_hash']['post']['parameters']).to eql(
-            [
-              { 'in' => 'formData', 'name' => 'a_hash[param_1]', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
-              { 'in' => 'formData', 'name' => 'a_hash[b_hash][param_2]', 'required' => true, 'type' => 'string' },
-              { 'in' => 'formData', 'name' => "a_hash[c_array]#{braces}[param_3]", 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-              { 'in' => 'formData', 'name' => 'a_hash_foo', 'required' => true, 'type' => 'string' }
-            ]
-          )
-        end
-      end
-    end
-  end
-end

data/spec/swagger_v2/parent_less_namespace_spec.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'a parent less namespace' do
-  include_context 'namespace example'
-
-  before :all do
-    class ParentLessApi < Grape::API
-      prefix :api
-      mount TheApi::ParentLessNamespaceApi
-      add_swagger_documentation version: 'v1'
-    end
-  end
-
-  def app
-    ParentLessApi
-  end
-
-  describe 'retrieves swagger-documentation on /swagger_doc' do
-    let(:route_name) { ':animal/:breed/queues/:queue_id/reservations' }
-    subject do
-      get '/api/swagger_doc.json'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/api/{animal}/{breed}/queues/{queue_id}/reservations']['get']['operationId'])
-        .to eql('getApiAnimalBreedQueuesQueueIdReservations')
-    end
-  end
-end

data/spec/swagger_v2/reference_entity_spec.rb

@@ -1,129 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'referenceEntity' do
-  before :all do
-    module MyAPI
-      module Entities
-        class Something < Grape::Entity
-          def self.entity_name
-            'SomethingCustom'
-          end
-
-          expose :text, documentation: { type: 'string', desc: 'Content of something.' }
-        end
-
-        class Kind < Grape::Entity
-          def self.entity_name
-            'KindCustom'
-          end
-
-          expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
-          expose :something, documentation: { type: Something, desc: 'Something interesting.' }
-        end
-
-        class Base < Grape::Entity
-          def self.entity_name
-            parts = to_s.split('::')
-
-            "MyAPI::#{parts.last}"
-          end
-
-          expose :title, documentation: { type: 'string', desc: 'Title of the parent.' }
-        end
-
-        class Child < Base
-          expose :child, documentation: { type: 'string', desc: 'Child property.' }
-        end
-      end
-
-      class ResponseModelApi < Grape::API
-        format :json
-        desc 'This returns kind and something or an error',
-             params: Entities::Kind.documentation.slice(:something),
-             entity: Entities::Kind,
-             http_codes: [
-               { code: 200, message: 'OK', model: Entities::Kind }
-             ]
-        params do
-          optional :something, desc: 'something as parameter'
-        end
-        get '/kind' do
-          kind = OpenStruct.new text: 'kind'
-          present kind, with: Entities::Kind
-        end
-
-        desc 'This returns a child entity',
-             entity: Entities::Child,
-             http_codes: [
-               { code: 200, message: 'OK', model: Entities::Child }
-             ]
-        get '/child' do
-          child = OpenStruct.new text: 'child'
-          present child, with: Entities::Child
-        end
-
-        add_swagger_documentation # models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
-      end
-    end
-  end
-
-  def app
-    MyAPI::ResponseModelApi
-  end
-
-  describe 'kind' do
-    subject do
-      get '/swagger_doc/kind'
-      JSON.parse(last_response.body)
-    end
-
-    it 'should document specified models' do
-      expect(subject['paths']['/kind']['get']['parameters']).to eq [{
-        'in' => 'query',
-        'name' => 'something',
-        'description' => 'Something interesting.',
-        'type' => 'SomethingCustom',
-        'required' => false
-      }]
-
-      expect(subject['definitions'].keys).to include 'SomethingCustom'
-      expect(subject['definitions']['SomethingCustom']).to eq(
-        'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
-      )
-
-      expect(subject['definitions'].keys).to include 'KindCustom'
-      expect(subject['definitions']['KindCustom']).to eq(
-        'type' => 'object',
-        'properties' => {
-          'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
-          'something' => {
-            '$ref' => '#/definitions/SomethingCustom',
-            'description' => 'Something interesting.'
-          }
-        },
-        'description' => 'KindCustom model'
-      )
-    end
-  end
-
-  describe 'child' do
-    subject do
-      get '/swagger_doc/child'
-      JSON.parse(last_response.body)
-    end
-
-    it 'should document specified models' do
-      expect(subject['definitions'].keys).to include 'MyAPI::Child'
-      expect(subject['definitions']['MyAPI::Child']).to eq(
-        'type' => 'object',
-        'properties' => {
-          'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },
-          'child' => { 'type' => 'string', 'description' => 'Child property.' }
-        },
-        'description' => 'MyAPI::Child model'
-      )
-    end
-  end
-end