Addes support for enum values in entity documentation and form parameters

[antek-drzewiecki]

Grape supports has a value restrictions trough arrays or Proc. Swagger UI supports form parameter restrictions trough the enum field. You can also document an entity enum values with the enum field in Swagger UI. This push request adds parameter value integration between Grape (Entity) and Swagger UI.

Usage:

class Status < Grape::Entity
  expose :text, documentation: { type: 'string', desc: 'Status update text.' }
  expose :links, using: Link, documentation: { type: 'link', is_array: true }
  expose :numbers, documentation: { type: 'integer', desc: 'favourite number', values: [1,2,3,4] } 
end

desc 'Creates a new status', entity: API::Entities::Status, params: API::Entities::Status.documentation
post '/statuses' do
        ...
end

desc 'Creates a new status', entity: API::Entities::Status 
params do
   required :numbers , type: Integer, values:[1,2,3]
   ...
end
post '/statuses' do
  ...
end 

[antek-drzewiecki]

This has effect on Swagger UI that the parameter number now gets an select drop down box with values 1 , 2 , 3 in it and the entity documentation shows all enum values before the parameter description.

[dblock]

Missing a period at the end ;)

[dblock]

This is good. Can you please amend the few small things noted above.

[antek-drzewiecki]

@dblock , done thanks for the feedback.

[dblock]

Btw, if you're going to use this in a production API, please do allow other genders than 'male' and 'female', for once facebook did it right :)

[dblock]

Great, merging.