Sha256: 4f12b5c14276dd9f0e60e2ca7cb688c1547c21be88da28efdd344ab1892e7aee

Contents?: true

Size: 1.01 KB

Versions: 18

Compression:

Stored size: 1.01 KB

Contents

# frozen_string_literal: true

require 'spec_helper'

describe 'API with additional options' do
  let(:api) do
    Class.new(Grape::API) do
      add_swagger_documentation \
        api_documentation: { desc: 'Swagger compatible API description' },
        specific_api_documentation: { desc: 'Swagger compatible API description for specific API' }
    end
  end

  subject do
    api.routes.map do |route|
      route.settings[:description]
    end
  end

  it 'documents api' do
    expect(subject).to eq(
      [
        { description: 'Swagger compatible API description' },
        {
          description: 'Swagger compatible API description for specific API',
          params: {
            'locale' => {
              desc: 'Locale of API documentation',
              required: false,
              type: 'Symbol'
            },
            'name' => {
              desc: 'Resource name of mounted API',
              required: true,
              type: 'String'
            }
          }
        }
      ]
    )
  end
end

Version data entries

18 entries across 18 versions & 2 rubygems

Version Path
gitlab-grape-swagger-1.5.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.5.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.4.2 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.4.1 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.4.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.3.1 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.3.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.2.1 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.2.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.1.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-1.0.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.34.2 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.34.1 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.34.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.33.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.32.1 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.32.0 spec/swagger_v2/api_documentation_spec.rb
grape-swagger-0.31.1 spec/swagger_v2/api_documentation_spec.rb