doc: add auth header fields (#34)

5 files changed, 102 insertions, 17 deletions

diff --git a/backend/controllers/recordController.go b/backend/controllers/recordController.go
index 27f39fc..3e64e14 100644
--- a/backend/controllers/recordController.go
+++ b/backend/controllers/recordController.go
@@ -23,6 +23,7 @@ import (
 //      @Summary        Post record with demo of a specific map.
 //      @Accept         mpfd
 //      @Produce        json
+//      @Param          Authorization           header          string  true    "JWT Token"
 //      @Param          demos                           formData        []file  true    "Demos"
 //      @Param          score_count                     formData        int             true    "Score Count"
 //      @Param          score_time                      formData        int             true    "Score Time"
diff --git a/backend/controllers/userController.go b/backend/controllers/userController.go
index cb6c15d..51c18d5 100644
--- a/backend/controllers/userController.go
+++ b/backend/controllers/userController.go
@@ -16,9 +16,10 @@ import (
 //      @Summary        Get profile page of session user.
 //      @Accept         json
 //      @Produce        json
-//      @Success        200     {object}        models.Response{data=models.ProfileResponse}
-//      @Failure        400     {object}        models.Response
-//      @Failure        401     {object}        models.Response
+//      @Param          Authorization   header          string  true    "JWT Token"
+//      @Success        200                             {object}        models.Response{data=models.ProfileResponse}
+//      @Failure        400                             {object}        models.Response
+//      @Failure        401                             {object}        models.Response
 //      @Router         /profile [get]
 func Profile(c *gin.Context) {
         // Check if user exists
@@ -202,9 +203,10 @@ func FetchUser(c *gin.Context) {
 //      @Summary        Update profile page of session user.
 //      @Accept         json
 //      @Produce        json
-//      @Success        200     {object}        models.Response{data=models.ProfileResponse}
-//      @Failure        400     {object}        models.Response
-//      @Failure        401     {object}        models.Response
+//      @Param          Authorization   header          string  true    "JWT Token"
+//      @Success        200                             {object}        models.Response{data=models.ProfileResponse}
+//      @Failure        400                             {object}        models.Response
+//      @Failure        401                             {object}        models.Response
 //      @Router         /profile [post]
 func UpdateUser(c *gin.Context) {
         // Check if user exists
@@ -243,6 +245,7 @@ func UpdateUser(c *gin.Context) {
 //      @Summary        Update country code of session user.
 //      @Accept         json
 //      @Produce        json
+//      @Param          Authorization   header          string  true    "JWT Token"
 //      @Param          country_code    query           string  true    "Country Code [XX]"
 //      @Success        200                             {object}        models.Response{data=models.ProfileResponse}
 //      @Failure        400                             {object}        models.Response
diff --git a/docs/docs.go b/docs/docs.go
index 70a7267..5cf5e50 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -1,5 +1,5 @@
-// Code generated by swaggo/swag. DO NOT EDIT.
-
+// Package docs GENERATED BY SWAG; DO NOT EDIT
+// This file was generated by swaggo/swag
 package docs
 
 import "github.com/swaggo/swag"
@@ -148,11 +148,17 @@ const docTemplate = `{
                 "summary": "Post record with demo of a specific map.",
                 "parameters": [
                     {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    },
+                    {
                         "type": "array",
                         "items": {
                             "type": "file"
                         },
-                        "collectionFormat": "csv",
                         "description": "Demos",
                         "name": "demos",
                         "in": "formData",
@@ -230,6 +236,15 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "summary": "Get profile page of session user.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -274,6 +289,13 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
                         "description": "Country Code [XX]",
                         "name": "country_code",
                         "in": "query",
@@ -321,6 +343,15 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "summary": "Update profile page of session user.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -555,11 +586,9 @@ var SwaggerInfo = &swag.Spec{
         BasePath:         "/v1",
         Schemes:          []string{},
         Title:            "Least Portals Database API",
-        Description:      "Backend API endpoints for Least Portals Database.",
+        Description:      "Backend API endpoints for the Least Portals Database.",
         InfoInstanceName: "swagger",
         SwaggerTemplate:  docTemplate,
-        LeftDelim:        "{{",
-        RightDelim:       "}}",
 }
 
 func init() {
diff --git a/docs/swagger.json b/docs/swagger.json
index 861610b..82fb64c 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -1,7 +1,7 @@
 {
     "swagger": "2.0",
     "info": {
-        "description": "Backend API endpoints for Least Portals Database.",
+        "description": "Backend API endpoints for the Least Portals Database.",
         "title": "Least Portals Database API",
         "contact": {},
         "license": {
@@ -141,11 +141,17 @@
                 "summary": "Post record with demo of a specific map.",
                 "parameters": [
                     {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    },
+                    {
                         "type": "array",
                         "items": {
                             "type": "file"
                         },
-                        "collectionFormat": "csv",
                         "description": "Demos",
                         "name": "demos",
                         "in": "formData",
@@ -223,6 +229,15 @@
                     "application/json"
                 ],
                 "summary": "Get profile page of session user.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -267,6 +282,13 @@
                 "parameters": [
                     {
                         "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
                         "description": "Country Code [XX]",
                         "name": "country_code",
                         "in": "query",
@@ -314,6 +336,15 @@
                     "application/json"
                 ],
                 "summary": "Update profile page of session user.",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "JWT Token",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index db0ab47..76b4e7b 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -93,7 +93,7 @@ definitions:
 host: lp.ardapektezol.com/api
 info:
   contact: {}
-  description: Backend API endpoints for Least Portals Database.
+  description: Backend API endpoints for the Least Portals Database.
   license:
     name: GNU General Public License, Version 2
     url: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
@@ -175,8 +175,12 @@ paths:
       consumes:
       - multipart/form-data
       parameters:
-      - collectionFormat: csv
-        description: Demos
+      - description: JWT Token
+        in: header
+        name: Authorization
+        required: true
+        type: string
+      - description: Demos
         in: formData
         items:
           type: file
@@ -228,6 +232,12 @@ paths:
     get:
       consumes:
       - application/json
+      parameters:
+      - description: JWT Token
+        in: header
+        name: Authorization
+        required: true
+        type: string
       produces:
       - application/json
       responses:
@@ -252,6 +262,12 @@ paths:
     post:
       consumes:
       - application/json
+      parameters:
+      - description: JWT Token
+        in: header
+        name: Authorization
+        required: true
+        type: string
       produces:
       - application/json
       responses:
@@ -277,6 +293,11 @@ paths:
       consumes:
       - application/json
       parameters:
+      - description: JWT Token
+        in: header
+        name: Authorization
+        required: true
+        type: string
       - description: Country Code [XX]
         in: query
         name: country_code