chore: updates swagger docs

influxdata · Dec 2, 2019 · 1779159 · 1779159
1 parent ddaa2c0
commit 1779159
Showing 1 changed file with 67 additions and 4 deletions.
diff --git a/http/swagger.yml b/http/swagger.yml
@@ -2222,15 +2222,18 @@ paths:
             required: false
             schema:
               type: string
-              enum: [properties]
+              enum: 
+                - properties
             description: Includes the cell view properties in the response if set to `properties`
       responses:
           '200':
             description: Get a single dashboard
             content:
               application/json:
                 schema:
-                  $ref: "#/components/schemas/Dashboard"
+                  oneOf:
+                    - $ref: "#/components/schemas/Dashboard"
+                    - $ref: "#/components/schemas/DashboardWithViewProperties"
           '404':
             description: Dashboard not found
             content:
@@ -7368,12 +7371,11 @@ components:
         width:
           type: integer
         properties: # field name is properties
-          ref: "#/components/schemas/ViewProperties"
+          $ref: "#/components/schemas/ViewProperties"
     Runs:
       type: object
       properties:
         links:
-          readOnly: true
           $ref: "#/components/schemas/Links"
         runs:
           type: array
@@ -8714,6 +8716,16 @@ components:
                 type: integer
               message:
                 type: string
+    CellWithViewProperties:
+      type: object
+      allOf:
+        - $ref: "#/components/schemas/Cell"
+        - type: object
+          properties:
+            name:
+              type: string
+            properties:
+              $ref: "#/components/schemas/ViewProperties"
     Cell:
       type: object
       properties:
@@ -8741,6 +8753,10 @@ components:
         viewID:
           type: string
           description: The reference to a view from the views API.
+    CellsWithViewProperties:
+      type: array
+      items:
+        $ref: "#/components/schemas/CellWithViewProperties"
     Cells:
       type: array
       items:
@@ -8784,6 +8800,53 @@ components:
       required:
         - orgID
         - name
+    DashboardWithViewProperties:
+      type: object
+      allOf:
+        - $ref: "#/components/schemas/CreateDashboardRequest"
+        - type: object
+          properties:
+            links:
+              type: object
+              example:
+                self: "/api/v2/dashboards/1"
+                cells: "/api/v2/dashboards/1/cells"
+                owners: "/api/v2/dashboards/1/owners"
+                members: "/api/v2/dashboards/1/members"
+                logs: "/api/v2/dashboards/1/logs"
+                labels: "/api/v2/dashboards/1/labels"
+                org: "/api/v2/labels/1"
+              properties:
+                self:
+                  $ref: "#/components/schemas/Link"
+                cells:
+                  $ref: "#/components/schemas/Link"
+                members:
+                  $ref: "#/components/schemas/Link"
+                owners:
+                  $ref: "#/components/schemas/Link"
+                logs:
+                  $ref: "#/components/schemas/Link"
+                labels:
+                  $ref: "#/components/schemas/Link"
+                org:
+                  $ref: "#/components/schemas/Link"
+            id:
+              readOnly: true
+              type: string
+            meta:
+              type: object
+              properties:
+                createdAt:
+                  type: string
+                  format: date-time
+                updatedAt:
+                  type: string
+                  format: date-time
+            cells:
+              $ref: "#/components/schemas/CellsWithViewProperties"
+            labels:
+              $ref: "#/components/schemas/Labels"
     Dashboard:
       type: object
       allOf: