How can I add a description for a Header' '[Required, Strict]

[Gau-thier]

In our APIs, we have one header which is declared as required because it is automatically added by our API Management.

Since none of the request will be done directly to our endpoint (100% pass through API Management), we find this confusing for our clients to have this header as required in our Swagger. We would like to add a description like:

added by API Management, do not care

Moreover, as we do not control anything on this header, it cannot be invalid:

should be hidden (or even not generated).

Thanks!

[sir4ur0n]

Though this feature is not well documented (in my opinion :smile: ), you can add a description to pretty much everything, usually by using the more generic ' version, which allows to pass a Description:

QueryParam' '[Required, Strict, Description "My description!"] "foobar"

Capture' '[Description "My description!"] "foobar"

Header' '[Required, Strict, Description "My description!"] "foobar"

[akhesaCaro]

Hi, Servant-swagger will be moved into the main Servant repo (see : https://github.com/haskell-servant/servant/pull/1475) If this issue is still relevant, would it be possible for you to summit it there? : https://github.com/haskell-servant/servant/issues

Thanks in advance!