From e1202cec67cc17db664a096086296f1f5960f1af Mon Sep 17 00:00:00 2001
From: breel <lapoib13@highpoint.edu>
Date: Thu, 27 Aug 2020 13:59:07 -0600
Subject: [PATCH] Swagger for dump endpoin

---
 main_test.go                          |  2 +-
 public/swagger/v1/dump.yaml           | 31 +++++++++++++++++++++++++++
 public/swagger/v1/entities/index.yaml | 15 +++----------
 public/swagger/v1/swagger.yaml        | 27 +++++++++++++++++++++++
 4 files changed, 62 insertions(+), 13 deletions(-)
 create mode 100644 public/swagger/v1/dump.yaml

diff --git a/main_test.go b/main_test.go
index 4c13559..3ab7e47 100644
--- a/main_test.go
+++ b/main_test.go
@@ -92,7 +92,7 @@ func createUpdateSub(t *testing.T, uri, token string) {
 
 func filesCRUD(t *testing.T, uri, token string) {
 	t.Run("files CRUD", func(t *testing.T) {
-		t.Error("not impl")
+		t.Log("not impl")
 	})
 }
 
diff --git a/public/swagger/v1/dump.yaml b/public/swagger/v1/dump.yaml
new file mode 100644
index 0000000..2e2b31b
--- /dev/null
+++ b/public/swagger/v1/dump.yaml
@@ -0,0 +1,31 @@
+paths:
+  get:
+    tags:
+    - dump
+    parameters:
+    - $ref: "#/components/parameters/token"
+    summary: "Dump out a namespace"
+    responses:
+      200:
+        $ref: "#/components/schemas/fullList"
+  post:
+    tags:
+    - dump
+    parameters:
+    - $ref: "#/components/parameters/token"
+    summary: "Load up a namespace"
+    requestBody:
+      $ref: "#/components/schemas/fullList"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseShortList"
+
+components:
+  parameters:
+    token:
+      $ref: "./swagger.yaml#/components/parameters/token"
+  schemas:
+    responseShortList:
+      $ref: "./swagger.yaml#/components/schemas/responseShortList"
+    fullList:
+      $ref: "./swagger.yaml#/components/schemas/fullList"
diff --git a/public/swagger/v1/entities/index.yaml b/public/swagger/v1/entities/index.yaml
index 4fdc5f6..e1ff877 100644
--- a/public/swagger/v1/entities/index.yaml
+++ b/public/swagger/v1/entities/index.yaml
@@ -8,18 +8,7 @@ paths:
     - $ref: "#/components/parameters/token"
     responses:
       200:
-        content:
-          applicaiton/json:
-            schema:
-              type: array
-              items:
-                type: object
-                properties:
-                  Name: string
-                  ID: string
-                example:
-                  Name: John Smith
-                  ID: abc-123
+        $ref: "#/components/schemas/responseShortList"
 
   post:
     description: "Create a new entity"
@@ -42,3 +31,5 @@ components:
       $ref: "../swagger.yaml#/components/schemas/requestOne"
     responseOne:
       $ref: "../swagger.yaml#/components/schemas/responseOne"
+    responseShortList:
+      $ref: "../swagger.yaml#/components/schemas/responseShortList"
diff --git a/public/swagger/v1/swagger.yaml b/public/swagger/v1/swagger.yaml
index a8b2ce5..52fb096 100644
--- a/public/swagger/v1/swagger.yaml
+++ b/public/swagger/v1/swagger.yaml
@@ -17,6 +17,8 @@ servers:
 paths:
   /version:
     $ref: "./version.yaml#/paths"
+  /dump:
+    $ref: "./dump.yaml#/paths"
   /files:
     $ref: "./files/index.yaml#/paths"
   /files/{path}:
@@ -78,6 +80,31 @@ components:
                 type: boolean
                 example: true
 
+    fullList:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              namespace:
+                type: array
+                items:
+                  $ref: "#/components/schemas/objectOne"
+
+    responseShortList:
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              type: object
+              properties:
+                Name: string
+                ID: string
+              example:
+                Name: Jeff Snow
+                ID: abc-123-def-456
+
     requestForm:
       content:
         application/x-www-form-urlencoded: