From 1e1cd261dd9c944f595c9023c8aa3e76aae751af Mon Sep 17 00:00:00 2001
From: Mitchell Riedstra <mitch@riedstra.dev>
Date: Thu, 5 Jan 2023 21:10:26 -0500
Subject: Start on swagger docs

---
 docs/swagger.yaml | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 docs/swagger.yaml

(limited to 'docs/swagger.yaml')

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
new file mode 100644
index 0000000..bcff994
--- /dev/null
+++ b/docs/swagger.yaml
@@ -0,0 +1,108 @@
+basePath: /api
+definitions:
+  main.Credentials:
+    description: User's credentials
+    properties:
+      Password:
+        type: string
+      Username:
+        type: string
+    type: object
+info:
+  contact:
+    email: mitch@riedstra.dev
+    name: Mitchell Riedstra
+    url: https://riedstra.dev
+  description: User's credentials
+  license:
+    name: ISC
+  title: Simple Pastebin API
+  version: "1.0"
+paths:
+  /v0/del/{id}:
+    delete:
+      description: Remove a paste from the filesystem
+      parameters:
+      - description: Paste ID
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - text/plain
+      responses: {}
+      summary: Deletes a paste for a given ID
+      tags:
+      - v0
+  /v0/view/{id}:
+    get:
+      description: Fetches the contents of a paste if given an ID
+      parameters:
+      - description: Paste ID
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - text/plain
+      responses: {}
+      summary: View a paste for a given ID
+      tags:
+      - v0
+  /v1/del/{id}:
+    delete:
+      description: Remove a paste from the filesystem
+      parameters:
+      - description: Paste ID
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses: {}
+      summary: Deletes a paste for a given ID
+      tags:
+      - v1
+  /v1/getToken:
+    post:
+      consumes:
+      - application/json
+      description: Returns an API key that's valid for a pre-determined amount of
+        hours
+      parameters:
+      - description: User Credentials
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/main.Credentials'
+      produces:
+      - application/json
+      responses: {}
+      summary: Get an API key with valid credentials
+      tags:
+      - v1
+  /v1/view/{id}:
+    get:
+      description: Fetches the contents of a paste if given an ID
+      parameters:
+      - description: Paste ID
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses: {}
+      summary: View a paste for a given ID
+      tags:
+      - v1
+securityDefinitions:
+  "":
+    in: header
+    name: Authorization
+    type: apiKey
+  BasicAuth:
+    type: basic
+swagger: "2.0"
-- 
cgit v1.2.3