grape-swagger-entity icon indicating copy to clipboard operation
grape-swagger-entity copied to clipboard

Does not support desc in entity type?

Open run27017 opened this issue 4 years ago • 3 comments

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

run27017 avatar Apr 22 '20 03:04 run27017

Hello, did you try to use description instead of desc?

kzaitsev avatar Apr 22 '20 07:04 kzaitsev

@Bugagazavr description doesn't work at all regardless of whether is_array is true or false:

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

run27017 avatar Apr 22 '20 08:04 run27017

Ok, I will try to look into this and fix it.

kzaitsev avatar Apr 22 '20 08:04 kzaitsev