Skip to content

Does not support desc in entity type? #44

@run27017

Description

@run27017

versions:

  • grape (1.3.0)
  • grape-entity (0.7.1)
  • grape-swagger (1.0.0)
  • grape-swagger-entity (0.3.4)

In below 1x1 relation, I set an desc 'Address...' in address field, but it doesn't render the desc in swagger-ui.

  module Entities
    class Client < Grape::Entity
      expose :name, documentation: { type: 'string', desc: 'Name' }
      expose :address, using: Entities::Address,
        documentation: { type: 'Entities::Address', desc: 'Address...', param_type: 'body', is_array: false }
    end

    class Address < Grape::Entity
      expose :street, documentation: { type: 'string', desc: 'Street' }
    end
  end

image

However, if I set the field as an array, it will render it.

      expose :address, using: Entities::Address,
        documentation: { type: 'Entities::Address', desc: 'Addresses...', param_type: 'body', is_array: true }

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions