go-openapi / spec

openapi specification object model
Apache License 2.0
389 stars 98 forks source link

Added description field support to the APIKey Auth #152

Closed pomaretta closed 2 years ago

pomaretta commented 2 years ago

Adding description to the API Key authentication, to allow show up short descriptions or tips to the user, to help correctly setup API Key.

pomaretta commented 2 years ago

I agree, the current implementation is good and if the description is needed, the best way to make it is with auth.SecuritySchemeProps.Description.