Header is not displaying in Swagger UI

[brahamshakti]

This Code is not displaying header field in swagger UI

desc "Return super-secret information", {
  headers: {
    "XAuthToken" => {
      description: "Valdates your identity",
      required: true
    },
   "XOptionalHeader" => {
     description: "Not really needed",
     required: false
   }
 }
}

Earlier It used to be like

But now it is showing no header field with above Code

How do I fix this issue.

[LeFnord]

would be cool to write a spec (similar to this one: api_swagger_v2_headers_spec.rb

so it could be reproduced

and which version did you using?

[brahamshakti]

I am using version 0.20.1. Also My swagger doc looks like this

    {
    "get": {
        "description": "Get all rodeos",
        "headers": {
            "XAuthToken": {
                "description": "Valdates your identity",
                "required": true
            }
        },
        "produces": [
            "application/json"
        ],
        "responses": {
            "200": {
                "description": "Get all rodeos"
            }
        },
        "tags": [
            "rodeos"
        ],
        "operationId": "getV1Rodeos"
    }
}

But this is not creating header field.

[LeFnord]

ok, I see …
the so defined header should go into the response object,
to define header parameters, take a parameter and set the param_type to header
see: api_swagger_v2_param_type_spec.rb

[brahamshakti]

It would be better if you could provide an alternative solution in form of some patch. Sorry but I think modifying 100s of apis to add just one extra parameter does not look a good approach. Can I accept some sort of patch in near future from you

[dblock]

@brahamshakti What exactly are you proposing? What would you like to write in your API? We'll accept patches from you, thanks.

I think you want to reuse parameters as described in https://github.com/ruby-grape/grape#helpers.

[wleeper]

doing from the referenced test case

        params do
          optional :in_query, type: String, documentation: { param_type: 'query' }
          optional :in_header, type: String, documentation: { param_type: 'header' }
        end

does not really work. It will make valid swagger spec, but the grape code is looking for the in_header parameter in the params list not in the header. If it were a required field it would fail if you actually put the parameter in the header.

[LeFnord]

should be solved with @wleeper PR

but the question is always, how to differ between stuff for request and stuff for response for documentation …

what are your thoughts?

[LeFnord]

@brahamshakti give it a try, and close the issue

[brahamshakti]

Thanks to @wleeper, my issue is resolved with this pull request. I am closing this issue for now. Thanks to all.