re-add docs

2023-05-27 11:52:08 -05:00
parent c6e48a057d
commit 2a54b5eb65
4 changed files with 455 additions and 1 deletions
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -0,0 +1,108 @@
+basePath: /api/v1
+host: durpapi.durp.info
+info:
+  contact:
+    email: support@swagger.io
+    name: API Support
+    url: http://www.swagger.io/support
+  description: API for Durp's needs
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  termsOfService: http://swagger.io/terms/
+  title: DurpAPI
+  version: "1.0"
+paths:
+  /health/getHealth:
+    get:
+      consumes:
+      - application/json
+      description: Get the health of the API
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: response
+          schema:
+            type: string
+      summary: Generate Health status
+      tags:
+      - health
+  /openai/general:
+    get:
+      consumes:
+      - application/json
+      description: Ask ChatGPT a general question
+      parameters:
+      - description: Ask ChatGPT a general question
+        in: query
+        name: message
+        required: true
+        type: string
+      produces:
+      - text/plain
+      responses:
+        "200":
+          description: response
+          schema:
+            type: string
+      summary: Gerneral ChatGPT
+      tags:
+      - openai
+  /openai/travelagent:
+    get:
+      consumes:
+      - application/json
+      description: Ask ChatGPT for suggestions as if it was a travel agent
+      parameters:
+      - description: Ask ChatGPT for suggestions as a travel agent
+        in: query
+        name: message
+        required: true
+        type: string
+      produces:
+      - text/plain
+      responses:
+        "200":
+          description: response
+          schema:
+            type: string
+      summary: Travel Agent ChatGPT
+      tags:
+      - openai
+  /token/GenerateToken:
+    get:
+      consumes:
+      - application/json
+      description: Get the health of the API
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: response
+          schema:
+            type: string
+      summary: Generate Health status
+      tags:
+      - token
+  /unraid/powerusage:
+    get:
+      consumes:
+      - application/json
+      description: Gets the PSU Data from unraid
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: response
+          schema:
+            type: string
+      summary: Unraid PSU Stats
+      tags:
+      - unraid
+securityDefinitions:
+  ApiKeyAuth:
+    in: header
+    name: Authorization
+    type: apiKey
+swagger: "2.0"