Forum Discussion

HenrikHL's avatar
HenrikHL
Frequent Contributor
8 months ago

It does not seem like setting a header in a response as required makes any difference

I would expect a little red `*` to appear next to the header-name when I specify the header as a required-header. Here is an example As can be seen - no required "red star" next to the `API Ver...
HenrikHL's avatar
HenrikHL
Frequent Contributor
8 months ago

Hi Tom_S ,

Thank you for the prompt reply :-)

When you write:

However, for headers, even though they can be defined as required (required: true), Swagger UI does not display a red asterisk or similar indicator for them. This is by design and not an issue with the tool. The required header will still be enforced during validation.

I assume you mean required fields on headers in responses - because it works fine for headers in requests:

 

  • Tom_S's avatar
    Tom_S
    Icon for Staff rankStaff
    7 months ago

    Hi Henrik, yes, you're correct. The red asterix is displayed for headers in requests, as this field is required by the user of the API to fill in when sending a request.