swagger OK resopnse bodies

2020-08-09 22:23:39 -06:00
parent f11261f0da
commit 4aea3dab40
9 changed files with 288 additions and 80 deletions
--- a/public/swagger/v1/entities/id.yaml
+++ b/public/swagger/v1/entities/id.yaml
@@ -0,0 +1,66 @@
+paths:
+  summary: "Interact with one entity within a namespace"
+  delete:
+    description: "Delete an existing entity"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOK"
+
+  get:
+    description: "Get an existing entity"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOneResolved"
+
+  put:
+    description: "Replace an existing entity"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    requestBody:
+      $ref: "#/components/schemas/requestOne"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+  patch:
+    description: "Update an existing entity"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    requestBody:
+      $ref: "#/components/schemas/requestOne"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+components:
+  parameters:
+    token:
+      $ref: "../swagger.yaml#/components/parameters/token"
+    id:
+      $ref: "../swagger.yaml#/components/parameters/id"
+
+  schemas:
+    requestOne:
+      $ref: "../swagger.yaml#/components/schemas/requestOne"
+    responseOne:
+      $ref: "../swagger.yaml#/components/schemas/responseOne"
+    responseOneResolved:
+      $ref: "../swagger.yaml#/components/schemas/responseOneResolved"
+    responseOK:
+      $ref: "../swagger.yaml#/components/schemas/responseOK"
--- a/public/swagger/v1/entities/idsub.yaml
+++ b/public/swagger/v1/entities/idsub.yaml
@@ -0,0 +1,71 @@
+paths:
+  summary: "Interact with one field of one entity within a namespace"
+  delete:
+    description: "Delete an existing entity's field's value"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    - $ref: "#/components/parameters/path"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+  get:
+    description: "Get an existing entity's field's value"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    - $ref: "#/components/parameters/path"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+  put:
+    description: "Replace an existing entity's field's value"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    - $ref: "#/components/parameters/path"
+    requestBody:
+      $ref: "#/components/schemas/requestOne"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+  patch:
+    description: "Update an existing entity's field's value"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    - $ref: "#/components/parameters/id"
+    - $ref: "#/components/parameters/path"
+    requestBody:
+      $ref: "#/components/schemas/requestOne"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+components:
+  parameters:
+    token:
+      $ref: "../swagger.yaml#/components/parameters/token"
+    id:
+      $ref: "../swagger.yaml#/components/parameters/id"
+    path:
+      $ref: "../swagger.yaml#/components/parameters/path"
+  schemas:
+    responseOne:
+      $ref: "../swagger.yaml#/components/schemas/responseOne"
+    requestOne:
+      $ref: "../swagger.yaml#/components/schemas/requestOne"
+    objectOne:
+      $ref: "../swagger.yaml#/components/schemas/objectOne"
+    responseOK:
+      $ref: "../swagger.yaml#/components/schemas/responseOK"
--- a/public/swagger/v1/entities/index.yaml
+++ b/public/swagger/v1/entities/index.yaml
@@ -0,0 +1,44 @@
+paths:
+  summary: "Interact with all entities within a namespace"
+  get:
+    description: "Get names and IDs of all entities"
+    tags:
+    - entities
+    parameters:
+    - $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
+
+  post:
+    description: "Create a new entity"
+    tags:
+    - entities
+    parameters:
+    - $ref: "#/components/parameters/token"
+    requestBody:
+      $ref: "#/components/schemas/requestOne"
+    responses:
+      200:
+        $ref: "#/components/schemas/responseOne"
+
+components:
+  parameters:
+    token:
+      $ref: "../swagger.yaml#/components/parameters/token"
+  schemas:
+    requestOne:
+      $ref: "../swagger.yaml#/components/schemas/requestOne"
+    responseOne:
+      $ref: "../swagger.yaml#/components/schemas/responseOne"