Update Swagger Docs from #370 (#376)

backend/app/api/static/docs/docs.go

@@ -566,6 +566,9 @@ const docTemplate = `{
                         "Bearer": []
                     }
                 ],
+                "consumes": [
+                    "multipart/form-data"
+                ],
                 "produces": [
                     "application/json"
                 ],
@@ -737,6 +740,9 @@ const docTemplate = `{
                         "Bearer": []
                     }
                 ],
+                "consumes": [
+                    "multipart/form-data"
+                ],
                 "produces": [
                     "application/json"
                 ],
@@ -921,6 +927,13 @@ const docTemplate = `{
                 ],
                 "summary": "Get Maintenance Log",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Item ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "enum": [
                             "scheduled",
@@ -963,6 +976,13 @@ const docTemplate = `{
                 ],
                 "summary": "Create Maintenance Entry",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Item ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Entry Data",
                         "name": "payload",
@@ -1434,6 +1454,13 @@ const docTemplate = `{
                 ],
                 "summary": "Update Maintenance Entry",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Maintenance ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Entry Data",
                         "name": "payload",
@@ -1466,6 +1493,15 @@ const docTemplate = `{
                     "Maintenance"
                 ],
                 "summary": "Delete Maintenance Entry",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Maintenance ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "204": {
                         "description": "No Content"
@@ -1548,13 +1584,6 @@ const docTemplate = `{
                 ],
                 "summary": "Test Notifier",
                 "parameters": [
-                    {
-                        "type": "string",
-                        "description": "Notifier ID",
-                        "name": "id",
-                        "in": "path",
-                        "required": true
-                    },
                     {
                         "type": "string",
                         "description": "URL",
@@ -1752,20 +1781,6 @@ const docTemplate = `{
                 ],
                 "summary": "User Login",
                 "parameters": [
-                    {
-                        "type": "string",
-                        "example": "admin@admin.com",
-                        "description": "string",
-                        "name": "username",
-                        "in": "formData"
-                    },
-                    {
-                        "type": "string",
-                        "example": "admin",
-                        "description": "string",
-                        "name": "password",
-                        "in": "formData"
-                    },
                     {
                         "description": "Login Data",
                         "name": "payload",
@@ -3050,13 +3065,15 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "admin"
                 },
                 "stayLoggedIn": {
                     "type": "boolean"
                 },
                 "username": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "admin@admin.com"
                 }
             }
         },

backend/app/api/static/docs/swagger.json

@@ -559,6 +559,9 @@
                         "Bearer": []
                     }
                 ],
+                "consumes": [
+                    "multipart/form-data"
+                ],
                 "produces": [
                     "application/json"
                 ],
@@ -730,6 +733,9 @@
                         "Bearer": []
                     }
                 ],
+                "consumes": [
+                    "multipart/form-data"
+                ],
                 "produces": [
                     "application/json"
                 ],
@@ -914,6 +920,13 @@
                 ],
                 "summary": "Get Maintenance Log",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Item ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "enum": [
                             "scheduled",
@@ -956,6 +969,13 @@
                 ],
                 "summary": "Create Maintenance Entry",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Item ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Entry Data",
                         "name": "payload",
@@ -1427,6 +1447,13 @@
                 ],
                 "summary": "Update Maintenance Entry",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Maintenance ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Entry Data",
                         "name": "payload",
@@ -1459,6 +1486,15 @@
                     "Maintenance"
                 ],
                 "summary": "Delete Maintenance Entry",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Maintenance ID",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
                 "responses": {
                     "204": {
                         "description": "No Content"
@@ -1541,13 +1577,6 @@
                 ],
                 "summary": "Test Notifier",
                 "parameters": [
-                    {
-                        "type": "string",
-                        "description": "Notifier ID",
-                        "name": "id",
-                        "in": "path",
-                        "required": true
-                    },
                     {
                         "type": "string",
                         "description": "URL",
@@ -1745,20 +1774,6 @@
                 ],
                 "summary": "User Login",
                 "parameters": [
-                    {
-                        "type": "string",
-                        "example": "admin@admin.com",
-                        "description": "string",
-                        "name": "username",
-                        "in": "formData"
-                    },
-                    {
-                        "type": "string",
-                        "example": "admin",
-                        "description": "string",
-                        "name": "password",
-                        "in": "formData"
-                    },
                     {
                         "description": "Login Data",
                         "name": "payload",
@@ -3043,13 +3058,15 @@
             "type": "object",
             "properties": {
                 "password": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "admin"
                 },
                 "stayLoggedIn": {
                     "type": "boolean"
                 },
                 "username": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "admin@admin.com"
                 }
             }
         },

backend/app/api/static/docs/swagger.yaml

@@ -729,10 +729,12 @@ definitions:
   v1.LoginForm:
     properties:
       password:
+        example: admin
         type: string
       stayLoggedIn:
         type: boolean
       username:
+        example: admin@admin.com
         type: string
     type: object
   v1.TokenResponse:
@@ -1135,6 +1137,8 @@ paths:
       - Items
   /v1/items/{id}/attachments:
     post:
+      consumes:
+      - multipart/form-data
       parameters:
       - description: Item ID
         in: path
@@ -1248,6 +1252,11 @@ paths:
   /v1/items/{id}/maintenance:
     get:
       parameters:
+      - description: Item ID
+        in: path
+        name: id
+        required: true
+        type: string
       - enum:
         - scheduled
         - completed
@@ -1275,6 +1284,11 @@ paths:
       - Item Maintenance
     post:
       parameters:
+      - description: Item ID
+        in: path
+        name: id
+        required: true
+        type: string
       - description: Entry Data
         in: body
         name: payload
@@ -1361,6 +1375,8 @@ paths:
       - Items
   /v1/items/import:
     post:
+      consumes:
+      - multipart/form-data
       parameters:
       - description: Image to upload
         in: formData
@@ -1623,6 +1639,12 @@ paths:
       - Maintenance
   /v1/maintenance/{id}:
     delete:
+      parameters:
+      - description: Maintenance ID
+        in: path
+        name: id
+        required: true
+        type: string
       produces:
       - application/json
       responses:
@@ -1635,6 +1657,11 @@ paths:
       - Maintenance
     put:
       parameters:
+      - description: Maintenance ID
+        in: path
+        name: id
+        required: true
+        type: string
       - description: Entry Data
         in: body
         name: payload
@@ -1731,11 +1758,6 @@ paths:
   /v1/notifiers/test:
     post:
       parameters:
-      - description: Notifier ID
-        in: path
-        name: id
-        required: true
-        type: string
       - description: URL
         in: query
         name: url
@@ -1819,16 +1841,6 @@ paths:
       - application/x-www-form-urlencoded
       - application/json
       parameters:
-      - description: string
-        example: admin@admin.com
-        in: formData
-        name: username
-        type: string
-      - description: string
-        example: admin
-        in: formData
-        name: password
-        type: string
       - description: Login Data
         in: body
         name: payload