docs: update to latest swagger config

peterxcli · Feb 4, 2024 · 58b27b5 · 58b27b5
1 parent 89de7d7
commit 58b27b5
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 6 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -353,13 +353,25 @@ const docTemplate = `{
                         }
                     },
                     "400": {
-                        "description": "Bad Request - Invalid input",
+                        "description": "Bad Request - Invalid input, such as invalid time format or missing required fields",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "409": {
+                        "description": "Conflict - User already subscribed to the event",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "422": {
+                        "description": "Unprocessable Entity - User has exceeded the maximum number of subscriptions",
                         "schema": {
                             "$ref": "#/definitions/bikefest_pkg_model.Response"
                         }
                     },
                     "500": {
-                        "description": "Internal Server Error",
+                        "description": "Internal Server Error - Error storing the event, subscribing the user, or enqueuing the event notification",
                         "schema": {
                             "$ref": "#/definitions/bikefest_pkg_model.Response"
                         }
@@ -561,6 +573,18 @@ const docTemplate = `{
                             "$ref": "#/definitions/bikefest_pkg_model.UserResponse"
                         }
                     },
+                    "401": {
+                        "description": "Unauthorized: Invalid or expired token",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "404": {
+                        "description": "User not found",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
                     "500": {
                         "description": "Internal Server Error",
                         "schema": {
@@ -686,6 +710,12 @@ const docTemplate = `{
                             "$ref": "#/definitions/bikefest_pkg_model.UserResponse"
                         }
                     },
+                    "404": {
+                        "description": "User not found",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
                     "500": {
                         "description": "Internal Server Error",
                         "schema": {

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -342,13 +342,25 @@
                         }
                     },
                     "400": {
-                        "description": "Bad Request - Invalid input",
+                        "description": "Bad Request - Invalid input, such as invalid time format or missing required fields",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "409": {
+                        "description": "Conflict - User already subscribed to the event",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "422": {
+                        "description": "Unprocessable Entity - User has exceeded the maximum number of subscriptions",
                         "schema": {
                             "$ref": "#/definitions/bikefest_pkg_model.Response"
                         }
                     },
                     "500": {
-                        "description": "Internal Server Error",
+                        "description": "Internal Server Error - Error storing the event, subscribing the user, or enqueuing the event notification",
                         "schema": {
                             "$ref": "#/definitions/bikefest_pkg_model.Response"
                         }
@@ -550,6 +562,18 @@
                             "$ref": "#/definitions/bikefest_pkg_model.UserResponse"
                         }
                     },
+                    "401": {
+                        "description": "Unauthorized: Invalid or expired token",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
+                    "404": {
+                        "description": "User not found",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
                     "500": {
                         "description": "Internal Server Error",
                         "schema": {
@@ -675,6 +699,12 @@
                             "$ref": "#/definitions/bikefest_pkg_model.UserResponse"
                         }
                     },
+                    "404": {
+                        "description": "User not found",
+                        "schema": {
+                            "$ref": "#/definitions/bikefest_pkg_model.Response"
+                        }
+                    },
                     "500": {
                         "description": "Internal Server Error",
                         "schema": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -319,6 +319,10 @@ paths:
           description: User successfully retrieved
           schema:
             $ref: '#/definitions/bikefest_pkg_model.UserResponse'
+        "404":
+          description: User not found
+          schema:
+            $ref: '#/definitions/bikefest_pkg_model.Response'
         "500":
           description: Internal Server Error
           schema:
@@ -366,11 +370,22 @@ paths:
           schema:
             $ref: '#/definitions/bikefest_pkg_model.EventResponse'
         "400":
-          description: Bad Request - Invalid input
+          description: Bad Request - Invalid input, such as invalid time format or
+            missing required fields
+          schema:
+            $ref: '#/definitions/bikefest_pkg_model.Response'
+        "409":
+          description: Conflict - User already subscribed to the event
+          schema:
+            $ref: '#/definitions/bikefest_pkg_model.Response'
+        "422":
+          description: Unprocessable Entity - User has exceeded the maximum number
+            of subscriptions
           schema:
             $ref: '#/definitions/bikefest_pkg_model.Response'
         "500":
-          description: Internal Server Error
+          description: Internal Server Error - Error storing the event, subscribing
+            the user, or enqueuing the event notification
           schema:
             $ref: '#/definitions/bikefest_pkg_model.Response'
       security:
@@ -499,6 +514,14 @@ paths:
           description: Profile successfully retrieved
           schema:
             $ref: '#/definitions/bikefest_pkg_model.UserResponse'
+        "401":
+          description: 'Unauthorized: Invalid or expired token'
+          schema:
+            $ref: '#/definitions/bikefest_pkg_model.Response'
+        "404":
+          description: User not found
+          schema:
+            $ref: '#/definitions/bikefest_pkg_model.Response'
         "500":
           description: Internal Server Error
           schema: