swag icon indicating copy to clipboard operation
swag copied to clipboard

[BUG] - Security description annotation not working

Open sujit-baniya opened this issue 2 years ago • 2 comments

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

sujit-baniya avatar Jun 18 '22 03:06 sujit-baniya

@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.

ubogdan avatar Jun 18 '22 12:06 ubogdan

@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

sujit-baniya avatar Jun 18 '22 14:06 sujit-baniya