No way to specify a 'body' parameter for a PUT request

[abkonsta]

Because of the following code in grape-swagger.rb, around line 126:

paramType = path.match(":#{param}") ? 'path' : (method == 'POST') ? 'body' : 'query'

you cannot have a nice swagger UI for a PUT method with a text box for body. Should the above be amended to be something like this:

paramType = path.match(":#{param}") ? 
  'path' : (method == 'POST' || method == 'PUT') ? 'body' : 'query'

or should we introduce a DSL way to specify param type of 'body', something along the lines of

params do
  optional :body, body: true, desc: 'This parameter is the body of the request'
end

I am willing to submit a pull request once an acceptable approach is determined..

[tim-vandecasteele]

For now I'd do it with your first proposed method. Don't see any value to put it in an additional DSL. If you send a pull request, I'll happily merge this.

[abkonsta]

Hmm, it appears that the line in question was changed. It no longer offers a body paramType. Rather, everywhere where a 'body' paramType was used, it now uses 'form'.

For several individual parameters that is probably a needed change. Swagger spec, however, states that a 'body' parameter type is allowed:

https://github.com/wordnik/swagger-core/wiki/Parameters

Additionally, if there is a body parameter, do we want to support query parameters alongside with it? For example:

POST /path/coolness?api_key=7736366HAB6443YDa353&validation=strict HTTP/1.1
User-Agent: Rails 3.2

{
  "name": "value",
  "something": "else"
}

I think stripe does it that way, api_key is always a URL parameter for their API.

[dgutov]

+1

I can't find a way to specify request body for POST either. Looks like a result of #29.

Take this example:

https://grape-api-example.herokuapp.com/#!/accounts/POST--version-accounts---format-_post_1

The only POST operation (on accounts) takes a hash as input, and no matter what I put in the account field in the form, it responds with "missing parameter: account".

I have a more complex request in a real application, with an array inside, and likewise there's no way to input it using Swagger-UI.

do we want to support query parameters alongside with it?

I'd like to be able to. If we could just mark certain parameter as body, it would be helpful. Maybe in the desc options? body: true or body: "param_name", if there are several.

[Nerian]

+1

[dblock]

I added some notes to #49 around the concepts related to this. Lets talk about it there?

[LeFnord]

it is implemented in actual version