this gem supports model schema and body param type ?

[chebyte]

hi there I was seeing the code but seems that this gem doesnt support models and body param type, this is correct? I need that swagger-ui shows model schema and body param like this screenshot

I have some way to do that with this gem?

thanks for advance

[dblock]

There's some discussion about this in #49. This is pretty clear though of what we want from the screenshot, so I am going to leave this issue open.

[dspaeth-faber]

From documentation it should work with param_type: 'body'.

But it does not work like I expect it. When you use the example you get some thing like
a form parameter and a body parameter in the swager-ui . Furthor more
the param_type option work's only in the entity.

In the API you can't use this option like this:

class Clients < Grape::API
    version 'v1'

    desc 'Clients index'
     params do
        optional :request, type: Entities::Request, desc: '...', param_type: 'body'
      end
    get '/clients' do
      ...
    end
  end

You will end up with an exception inside the validation with the example above.

But what work is this:

     params do
        optional :request, type: Entities::Request, desc: ' ... '
      end
      post do
        status 202
        params
      end

post, put, and patch methods set the param_type automaticaly to 'body',
with get you wan't get you'r wanted result. And it make's no sense to have a body with a get request.

[enricribas]

We are doing the exact thing above but we are not getting param_type set to 'body'. According to the returned JSON we have a param_type of 'form'.

Any help would be appreciated.

[dspaeth-faber]

What version do you use of grape, grape-swagger, entity?

[enricribas]

Thanks. I did notice later that we were using an older version of grape-swagger (0.7.2, I think) that didn't have the change for the paramType for body. I tried to upgrade but getting a orm_adapter issue which I'll try and resolve. Thanks.

[albertogg]

hey @dspaeth-faber what you told @chebyte seem to make the "Parameter Type" to body, although I'm using a requires :data, type: Entities::Activity and I'm always getting that data is missing through swagger and data is invalid through curl.

module Entities
  class Activity < Grape::Entity
    expose :data
  end
end

I don't know what I'm missing 😞

edit: this is a PUT action btw.

[dspaeth-faber]

requires forces the parameter to exist, put I don't know if body params are checkted in the right way. Did you try optional?

[albertogg]

yes, I tried, and I get an empty parameter

[dspaeth-faber]

Can you make a gist from your API-Class? Do you use newest gem versions?

[eguneys]

Swagger documentation has a "models" option that describes entity types, which you can use for "type" in parameters. Is this possible?

[dblock]

@eguneys Yes, it's:

add_swagger_documentation \
        models: [
          Foo::Bar
       ]

[dblock]

What do we want to do with this issue? cc: @chebyte