Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] - Security description annotation not working #1236

Open
sujit-baniya opened this issue Jun 18, 2022 · 2 comments
Open

[BUG] - Security description annotation not working #1236

sujit-baniya opened this issue Jun 18, 2022 · 2 comments

Comments

@sujit-baniya
Copy link

I tried to add following comment for API Key security,

// @securityDefinitions.apikey  ApiKeyAuth
// @in                          header
// @name                        Authorization
// @description					Description for what is this security definition being used

Except description above parameters are parsed.
image

@ubogdan
Copy link
Contributor

ubogdan commented Jun 18, 2022

@sujit-baniya description is only working for OAUTH2 security definition.

But swag is an open-source project; If you find this very important, feel free to implement the missing feature, and I will be more than happy to assist you with a CR.

@sujit-baniya
Copy link
Author

@ubogdan I think it's important in terms to describe about authentication process (not limited to OAUTH2). Let me see if I can add this feature

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants