chore (docs): Update docs for auth requests

Owbird · Mar 3, 2024 · 5fc3559 · 5fc3559
1 parent fb64b93
commit 5fc3559
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -17,7 +17,7 @@ const docTemplate = `{
     "paths": {
         "/auth/login": {
             "post": {
-                "description": "Authenticates the user the based on the credentials and returns a token which will be used to authorize requests",
+                "description": "Authenticates the user the based on the credentials and returns a token which will be used to authorize requests as a bearer token",
                 "consumes": [
                     "application/json"
                 ],

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -6,7 +6,7 @@
     "paths": {
         "/auth/login": {
             "post": {
-                "description": "Authenticates the user the based on the credentials and returns a token which will be used to authorize requests",
+                "description": "Authenticates the user the based on the credentials and returns a token which will be used to authorize requests as a bearer token",
                 "consumes": [
                     "application/json"
                 ],

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -147,7 +147,7 @@ paths:
       consumes:
       - application/json
       description: Authenticates the user the based on the credentials and returns
-        a token which will be used to authorize requests
+        a token which will be used to authorize requests as a bearer token
       parameters:
       - description: Username
         in: body

diff --git a/internal/handlers/auth_handler.go b/internal/handlers/auth_handler.go
@@ -13,7 +13,7 @@ import (
 )
 
 // @Summary Authenticate a user
-// @Description Authenticates the user the based on the credentials and returns a token which will be used to authorize requests
+// @Description Authenticates the user the based on the credentials and returns a token which will be used to authorize requests as a bearer token
 // @Tags Auth
 // @Produce json
 // @Accept  json