haskell-servant / haskell-servant/servant-swagger

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

Open
#122 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
123
Forks
34
PR merge metrics
No merged PRs in 30d

Description

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`:
![image](https://user-images.githubusercontent.com/45454460/88781667-f5f01500-d18c-11ea-9979-eb3c623170d0.png)
>should be hidden (or even not generated).

Thanks!

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name any files, tests, or entry points. Start by locating the Swagger generation for required headers, then check how header descriptions and invalid or hidden parameters are represented; done means supporting the requested description and preventing this API Management header from being treated as a client-supplied invalid field.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.