grape-swagger 0.21.0 → 0.22.0

data/spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb

@@ -72,7 +72,7 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     specify do
       expect(subject['paths']['/wo_entities/in_body']['post']['parameters']).to eql(
         [
-          { 'name' => 'postWoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
+          { 'name' => 'WoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWoEntitiesInBody' } }
         ]
       )
     end
@@ -94,17 +94,16 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/wo_entities/in_body/{key}']['put']['parameters']).to eql(
         [
           { 'in' => 'path', 'name' => 'key', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          { 'name' => 'putWoEntitiesInBodyKey', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBodyKey' } }
+          { 'name' => 'WoEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWoEntitiesInBody' } }
         ]
       )
     end
 
     specify do
-      expect(subject['definitions']['putWoEntitiesInBodyKey']).to eql(
+      expect(subject['definitions']['putWoEntitiesInBody']).to eql(
         'description' => 'put in body /wo entity',
         'type' => 'object',
         'properties' => {
-          'key' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
           'in_body_1' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'in_body_1' },
           'in_body_2' => { 'type' => 'string', 'description' => 'in_body_2' },
           'in_body_3' => { 'type' => 'string', 'description' => 'in_body_3' }
@@ -122,19 +121,19 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
     specify do
       expect(subject['paths']['/with_entities/in_body']['post']['parameters']).to eql(
         [
-          { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postRequestResponseItem' } }
+          { 'name' => 'WithEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postWithEntitiesInBody' } }
         ]
       )
     end
 
     specify do
-      expect(subject['definitions']['postRequestResponseItem']).to eql(
-        'description' => 'post in body with entity',
+      expect(subject['definitions']['postWithEntitiesInBody']).to eql(
         'type' => 'object',
         'properties' => {
           'name' => { 'type' => 'string', 'description' => 'name' }
         },
-        'required' => ['name']
+        'required' => ['name'],
+        'description' => 'post in body with entity'
       )
     end
 
@@ -142,19 +141,18 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       expect(subject['paths']['/with_entities/in_body/{id}']['put']['parameters']).to eql(
         [
           { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
-          { 'name' => 'ResponseItem', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putRequestResponseItem' } }
+          { 'name' => 'WithEntitiesInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/putWithEntitiesInBody' } }
         ]
       )
     end
 
     specify do
-      expect(subject['definitions']['putRequestResponseItem']).to eql(
-        'description' => 'put in body with entity',
+      expect(subject['definitions']['putWithEntitiesInBody']).to eql(
         'type' => 'object',
         'properties' => {
-          'id' => { 'type' => 'integer', 'format' => 'int32', 'readOnly' => true },
           'name' => { 'type' => 'string', 'description' => 'name' }
-        }
+        },
+        'description' => 'put in body with entity'
       )
     end
   end

data/spec/swagger_v2/api_swagger_v2_response_spec.rb

@@ -11,7 +11,7 @@ describe 'response' do
         desc 'This returns something',
              params: Entities::UseResponse.documentation,
              failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
-        post '/params_response' do
+        post '/params_given' do
           { 'declared_params' => declared(params) }
         end
 
@@ -83,12 +83,12 @@ describe 'response' do
 
   describe 'uses params as response object' do
     subject do
-      get '/swagger_doc/params_response'
+      get '/swagger_doc/params_given'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['paths']['/params_response']['post']).to eql(
+      expect(subject['paths']['/params_given']['post']).to eql(
         'summary' => 'This returns something',
         'description' => 'This returns something',
         'produces' => ['application/json'],
@@ -101,8 +101,8 @@ describe 'response' do
           '201' => { 'description' => 'This returns something' },
           '400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
         },
-        'tags' => ['params_response'],
-        'operationId' => 'postParamsResponse'
+        'tags' => ['params_given'],
+        'operationId' => 'postParamsGiven'
       )
       expect(subject['definitions']).to eql(swagger_params_as_response_object)
     end

data/spec/swagger_v2/endpoint_versioned_path_spec.rb

@@ -1,30 +1,31 @@
 require 'spec_helper'
 
 describe 'Grape::Endpoint#path_and_definitions' do
-  before do
-    module API
-      module V1
-        class Item < Grape::API
-          version 'v1', using: :path
+  let(:api) do
+    item = Class.new(Grape::API) do
+      version 'v1', using: :path
 
-          resource :item do
-            get '/'
-          end
-        end
-      end
-
-      class Root < Grape::API
-        mount API::V1::Item
-        add_swagger_documentation add_version: true
+      resource :item do
+        get '/'
       end
     end
 
-    @options = { add_version: true }
-    @target_routes = API::Root.combined_namespace_routes
+    Class.new(Grape::API) do
+      mount item
+      add_swagger_documentation add_version: true
+    end
   end
 
+  let(:options) { { add_version: true } }
+  let(:target_routes) { api.combined_namespace_routes }
+
+  subject { api.endpoints[0].path_and_definition_objects(target_routes, options) }
+
   it 'is returning a versioned path' do
-    expect(API::V1::Item.endpoints[0]
-      .path_and_definition_objects(@target_routes, @options)[0].keys[0]).to eql '/v1/item'
+    expect(subject[0].keys[0]).to eq '/v1/item'
+  end
+
+  it 'tags the endpoint with the resource name' do
+    expect(subject.first['/v1/item'][:get][:tags]).to eq ['item']
   end
 end

data/spec/swagger_v2/namespaced_api_spec.rb

@@ -21,6 +21,26 @@ describe 'namespace' do
     end
   end
 
+  context 'with camel case namespace' do
+    def app
+      Class.new(Grape::API) do
+        namespace :camelCases do
+          get '/', desc: 'Look! An endpoint.'
+        end
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/camelCases']['get']
+    end
+
+    it 'shows the namespace description in the json spec' do
+      expect(subject['description']).to eql('Look! An endpoint.')
+    end
+  end
+
   context 'mounted' do
     def app
       namespaced_api = Class.new(Grape::API) do

data/spec/swagger_v2/param_multi_type_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'Params Multi Types' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        if Grape::VERSION < '0.14'
+          requires :input, type: [String, Integer]
+        else
+          requires :input, types: [String, Integer]
+        end
+        requires :another_input, type: [String, Integer]
+      end
+      post :action do
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc/action'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['paths']['/action']['post']['parameters']
+  end
+
+  it 'reads param type correctly' do
+    expect(subject).to eq [
+      {
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'required' => true
+      },
+      {
+        'in' => 'formData',
+        'name' => 'another_input',
+        'type' => 'string',
+        'required' => true
+      }
+    ]
+  end
+
+  describe 'header params' do
+    def app
+      Class.new(Grape::API) do
+        format :json
+
+        desc 'Some API', headers: { 'My-Header' => { required: true, description: 'Set this!' } }
+        params do
+          if Grape::VERSION < '0.14'
+            requires :input, type: [String, Integer]
+          else
+            requires :input, types: [String, Integer]
+          end
+          requires :another_input, type: [String, Integer]
+        end
+        post :action do
+        end
+
+        add_swagger_documentation
+      end
+    end
+
+    it 'has consistent types' do
+      types = subject.map { |param| param['type'] }
+      expect(types).to eq(%w(string string string))
+    end
+  end
+end

data/spec/swagger_v2/param_type_spec.rb

@@ -11,45 +11,72 @@ describe 'Params Types' do
       post :action do
       end
 
+      params do
+        requires :input, type: String, default: '14', documentation: { type: 'email', default: '42' }
+      end
+      post :action_with_doc do
+      end
+
       add_swagger_documentation
     end
   end
+  context 'with no documentation hash' do
+    subject do
+      get '/swagger_doc/action'
+      expect(last_response.status).to eq 200
+      body = JSON.parse last_response.body
+      body['paths']['/action']['post']['parameters']
+    end
 
-  subject do
-    get '/swagger_doc/action'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    body['paths']['/action']['post']['parameters']
-  end
+    it 'reads param type correctly' do
+      expect(subject).to eq [{
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'required' => true
+      }]
+    end
 
-  it 'reads param type correctly' do
-    expect(subject).to eq [{
-      'in' => 'formData',
-      'name' => 'input',
-      'type' => 'string',
-      'required' => true
-    }]
-  end
+    describe 'header params' do
+      def app
+        Class.new(Grape::API) do
+          format :json
 
-  describe 'header params' do
-    def app
-      Class.new(Grape::API) do
-        format :json
+          desc 'Some API', headers: { 'My-Header' => { required: true, description: 'Set this!' } }
+          params do
+            requires :input, type: String
+          end
+          post :action do
+          end
 
-        desc 'Some API', headers: { 'My-Header' => { required: true, description: 'Set this!' } }
-        params do
-          requires :input, type: String
-        end
-        post :action do
+          add_swagger_documentation
         end
+      end
 
-        add_swagger_documentation
+      it 'has consistent types' do
+        types = subject.map { |param| param['type'] }
+        expect(types).to eq(%w(string string))
       end
     end
+  end
+
+  context 'with documentation hash' do
+    subject do
+      get '/swagger_doc/action_with_doc'
+      expect(last_response.status).to eq 200
+      body = JSON.parse last_response.body
+      body['paths']['/action_with_doc']['post']['parameters']
+    end
 
-    it 'has consistent types' do
-      types = subject.map { |param| param['type'] }
-      expect(types).to eq(%w(string string))
+    it 'reads param type correctly' do
+      expect(subject).to eq [{
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'format' => 'email',
+        'default' => '42',
+        'required' => true
+      }]
     end
   end
 end

data/spec/swagger_v2/params_array_spec.rb

@@ -27,6 +27,36 @@ describe 'Group Params as Array' 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
+
       add_swagger_documentation
     end
   end
@@ -40,8 +70,8 @@ describe 'Group Params as Array' do
     specify do
       expect(subject['paths']['/groups']['post']['parameters']).to eql(
         [
-          { 'in' => 'formData', 'name' => 'required_group[][required_param_1]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-          { 'in' => 'formData', 'name' => 'required_group[][required_param_2]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
+          { 'in' => 'formData', 'name' => 'required_group[required_param_1]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+          { 'in' => 'formData', 'name' => 'required_group[required_param_2]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
         ]
       )
     end
@@ -56,10 +86,70 @@ describe 'Group Params as Array' do
     specify do
       expect(subject['paths']['/type_given']['post']['parameters']).to eql(
         [
-          { 'in' => 'formData', 'name' => 'typed_group[][id]', 'description' => 'integer given', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer' } },
-          { 'in' => 'formData', 'name' => 'typed_group[][name]', 'description' => 'string given', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
-          { 'in' => 'formData', 'name' => 'typed_group[][email]', 'description' => 'email given', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'string' } },
-          { 'in' => 'formData', 'name' => 'typed_group[][others]', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'integer' }, 'enum' => [1, 2, 3] }
+          { 'in' => 'formData', 'name' => 'typed_group[id]', 'description' => 'integer given', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'typed_group[name]', 'description' => 'string given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'typed_group[email]', 'description' => 'email given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false },
+          { 'in' => 'formData', 'name' => 'typed_group[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' => {
+            'type' => 'string', 'description' => 'nested array of strings'
+          },
+          'array_of_integer' => {
+            'type' => 'integer', 'format' => 'int32', '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', 'items' => {
+            'type' => 'string', 'description' => 'array of strings'
+          }
+        },
+        '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', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_of_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true }
         ]
       )
     end