OpenAPI Documentation Fixes in Ocean GKE

api/services/ocean/gke/paths/cluster-roll.yaml

@@ -18,9 +18,13 @@ put:
       application/json:
         schema:
           type: object
+          required:
+            - roll
           properties:
             roll:
               type: object
+              required:
+                - status
               description: >
                 Object that specifies the parameters of a roll (also called a deployment).
               properties:

api/services/ocean/gke/paths/cluster.yaml

@@ -48,7 +48,7 @@ put:
       application/json:
         schema:
           allOf:
-          - $ref: "../schemas/oceanClusterWrapper.yaml"
+          - $ref: "../schemas/oceanCluster-update.yaml"
   responses:
     200:
       $ref: "../responses/oceanGkeUpdateResponse.yaml"

api/services/ocean/gke/paths/clusters.yaml

@@ -35,7 +35,7 @@ post:
       application/json:
         schema:
           allOf:
-            - $ref:  "../schemas/oceanClusterWrapper.yaml"
+            - $ref:  "../schemas/oceanCluster-create.yaml"
             - type: "object"
               properties:
                 cluster:

api/services/ocean/gke/responses/ocean.yaml

@@ -19,6 +19,6 @@ content:
                 items:
                   type: array
                   items:
-                    $ref: "../schemas/oceanCluster.yaml"
+                    $ref: "../schemas/oceanCluster-create.yaml"
                 kind:
                   example: "spotinst:ocean:gcp:k8s"

api/services/ocean/gke/responses/oceanGkeGet.yaml

@@ -19,6 +19,6 @@ content:
                 items:
                   type: array
                   items:
-                    $ref: "../schemas/oceanCluster.yaml"
+                    $ref: "../schemas/oceanCluster-create.yaml"
                 kind:
                   example: "spotinst:ocean:gcp:k8s"

api/services/ocean/gke/responses/oceanGkeList.yaml

@@ -19,6 +19,6 @@ content:
                 items:
                   type: array
                   items:
-                    $ref: "../schemas/oceanCluster.yaml"
+                    $ref: "../schemas/oceanCluster-create.yaml"
                 kind:
                   example: "spotinst:ocean:gcp:k8s"

api/services/ocean/gke/responses/oceanGkeUpdateResponse.yaml

@@ -19,6 +19,6 @@ content:
                 items:
                   type: array
                   items:
-                    $ref: "../schemas/oceanCluster.yaml"
+                    $ref: "../schemas/oceanCluster-update.yaml"
                 kind:
                   example: "spotinst:ocean:gcp:k8s"

api/services/ocean/gke/schemas/manualHeadroomScheduledTaskCreate.yaml

@@ -1,14 +1,14 @@
 type: object
 title: manualHeadroomUpdate
-required:
-  - headrooms
 properties:
   headrooms:
     description: >
       Set custom headroom per VNG. Provide a list of launchSpec.autoscale.headroom objects.
     type: array
     items:
       type: object
+      required:
+        - numOfUnits
       properties:
         cpuPerUnit:
           description: >

api/services/ocean/gke/schemas/oceanCluster-create.yaml

@@ -0,0 +1,72 @@
+type: object
+required:
+  - cluster
+properties:
+  cluster:
+    type: object
+    description: The specification of the Ocean cluster.
+    required:
+      - name
+      - controllerClusterId
+      - compute
+    properties:
+      id:
+        type: string
+        readOnly: true
+        example: o-abcd1234
+        description: |
+          Ocean cluster identifier.
+      name:
+        type: string
+        example: "test"
+        description: >
+          Add a name for the Ocean cluster.
+      controllerClusterId:
+        type: string
+        example: "test-123124"
+        description: >
+          Enter the Ocean cluster identifier.
+      gke:
+        type: object
+        required:
+          - clusterName
+          - masterLocation
+        description: >
+          Use existing GKE cluster.
+        properties:
+          clusterName:
+            type: string
+            description: >
+              Required for the cluster.gke object.
+            example: test-cluster
+          masterLocation:
+            type: string
+            description: >
+              Required for the cluster.gke object.
+            example: us-central1-a
+      autoScaler:
+        $ref: "../schemas/ocean-autoScaler.yaml"
+      capacity:
+        $ref: "../schemas/ocean-capacity.yaml"
+      strategy:
+        $ref: "../schemas/ocean-strategy.yaml"
+      scheduling:
+        $ref: "../schemas/ocean-scheduling.yaml"
+      security:
+        $ref: "../schemas/ocean-security.yaml"
+      compute:
+        $ref: "../schemas/ocean-compute.yaml"
+      createdAt:
+        type: string
+        readOnly: true
+        format: date-time
+        example: "2021-03-17T08:13:08.000Z"
+        description: |
+          A timestamp of the Ocean creation.
+      updatedAt:
+        type: string
+        readOnly: true
+        format: date-time
+        example: "2021-03-17T15:06:13.000Z"
+        description: |
+          A timestamp of the latest Ocean update.

api/services/ocean/gke/schemas/oceanCluster-update.yaml

@@ -0,0 +1,65 @@
+type: object
+required:
+  - cluster
+properties:
+  cluster:
+    type: object
+    description: The specification of the Ocean cluster.
+    required:
+      - compute
+    properties:
+      id:
+        type: string
+        readOnly: true
+        example: o-abcd1234
+        description: |
+          Ocean cluster identifier.
+      name:
+        type: string
+        example: "test"
+        description: >
+          Add a name for the Ocean cluster.
+      gke:
+        type: object
+        required:
+          - clusterName
+          - masterLocation
+        description: >
+          Use existing GKE cluster.
+        properties:
+          clusterName:
+            type: string
+            description: >
+              Required for the cluster.gke object.
+            example: test-cluster
+          masterLocation:
+            type: string
+            description: >
+              Required for the cluster.gke object.
+            example: us-central1-a
+      autoScaler:
+        $ref: "../schemas/ocean-autoScaler.yaml"
+      capacity:
+        $ref: "../schemas/ocean-capacity.yaml"
+      strategy:
+        $ref: "../schemas/ocean-strategy.yaml"
+      scheduling:
+        $ref: "../schemas/ocean-scheduling.yaml"
+      security:
+        $ref: "../schemas/ocean-security.yaml"
+      compute:
+        $ref: "../schemas/ocean-compute.yaml"
+      createdAt:
+        type: string
+        readOnly: true
+        format: date-time
+        example: "2021-03-17T08:13:08.000Z"
+        description: |
+          A timestamp of the Ocean creation.
+      updatedAt:
+        type: string
+        readOnly: true
+        format: date-time
+        example: "2021-03-17T15:06:13.000Z"
+        description: |
+          A timestamp of the latest Ocean update.