update docs

Author: YaoxuanZhang

docs/swagger/docs.go

@@ -9,7 +9,16 @@ const docTemplate = `{
     "info": {
         "description": "{{escape .Description}}",
         "title": "{{.Title}}",
-        "contact": {},
+        "termsOfService": "http://swagger.io/terms/",
+        "contact": {
+            "name": "API Support",
+            "url": "http://www.swagger.io/support",
+            "email": "support@swagger.io"
+        },
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        },
         "version": "{{.Version}}"
     },
     "host": "{{.Host}}",
@@ -1867,17 +1876,29 @@ const docTemplate = `{
                 }
             }
         }
+    },
+    "securityDefinitions": {
+        "BotToken": {
+            "type": "apiKey",
+            "name": "X-Bot-Token",
+            "in": "header"
+        },
+        "CookieAuth": {
+            "type": "apiKey",
+            "name": "capy_auth",
+            "in": "cookie"
+        }
     }
 }`
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "",
-	Host:             "",
-	BasePath:         "",
+	Version:          "1.0",
+	Host:             "localhost:8080",
+	BasePath:         "/v1",
 	Schemes:          []string{},
-	Title:            "",
-	Description:      "",
+	Title:            "Capy API",
+	Description:      "API for Capy RPI Club Assistant",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",

docs/swagger/swagger.json

@@ -1,8 +1,22 @@
 {
     "swagger": "2.0",
     "info": {
-        "contact": {}
+        "description": "API for Capy RPI Club Assistant",
+        "title": "Capy API",
+        "termsOfService": "http://swagger.io/terms/",
+        "contact": {
+            "name": "API Support",
+            "url": "http://www.swagger.io/support",
+            "email": "support@swagger.io"
+        },
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        },
+        "version": "1.0"
     },
+    "host": "localhost:8080",
+    "basePath": "/v1",
     "paths": {
         "/auth/google": {
             "get": {
@@ -1856,5 +1870,17 @@
                 }
             }
         }
+    },
+    "securityDefinitions": {
+        "BotToken": {
+            "type": "apiKey",
+            "name": "X-Bot-Token",
+            "in": "header"
+        },
+        "CookieAuth": {
+            "type": "apiKey",
+            "name": "capy_auth",
+            "in": "cookie"
+        }
     }
 }

docs/swagger/swagger.yaml

@@ -1,3 +1,4 @@
+basePath: /v1
 definitions:
   dto.AddMemberRequest:
     properties:
@@ -222,8 +223,19 @@ definitions:
       uid:
         type: string
     type: object
+host: localhost:8080
 info:
-  contact: {}
+  contact:
+    email: support@swagger.io
+    name: API Support
+    url: http://www.swagger.io/support
+  description: API for Capy RPI Club Assistant
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  termsOfService: http://swagger.io/terms/
+  title: Capy API
+  version: "1.0"
 paths:
   /auth/google:
     get:
@@ -1188,4 +1200,13 @@ paths:
       summary: List user's organizations
       tags:
       - users
+securityDefinitions:
+  BotToken:
+    in: header
+    name: X-Bot-Token
+    type: apiKey
+  CookieAuth:
+    in: cookie
+    name: capy_auth
+    type: apiKey
 swagger: "2.0"