Header example values

[philsturgeon]

Seing as Swagger does not seem to support example values for securityDefinitions, I am defining an exampleToken header parameter and referencing it in every endpoint that requires the token.

parameters:
  exampleToken:
    name: Authorization
    in: header
    required: true
    type: string
    x-example: "Token=exampletoken1"

I'm using that x-example because I'm using Dredd which needs examples for things to work, and ReDoc supports this too - which is handy!

Right now the headers are referenced as existing, but no example shows up:

Apiary has a little "Headers" section above the request body:

If this could be added to ReDoc, it would be so damn handy!

Ofc for now I've got it hacked into the description, which is fine:

[adamaltman]

Nice idea (and good hack).

[RomanHotsiy]

@philsturgeon will the following representation work for you:

[philsturgeon]

This looks great, thank you @RomanGotsiy! Sorry, was in a field for a few days.

[RomanHotsiy]

@philsturgeon great! I will release a new ReDoc version with this feature today!