Ocean AWS OpenAPI Documentation Fixes

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

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

api/services/ocean/aws/paths/clusters-launchSpec.yaml

@@ -30,7 +30,7 @@ get:
     - "Ocean AWS"
   parameters:
     - $ref: "../../../../commons/parameters/accountId.yaml"
-    - $ref: "../../commons/parameters/oceanId-query.yaml"
+    - $ref: "../parameters/oceanId-query-optional.yaml"
   responses:
     200:
       $ref: "../responses/oceanLaunchSpecList.yaml"

api/services/ocean/aws/paths/workloadMigration.yaml

@@ -21,36 +21,6 @@ post:
       $ref: "../responses/migrationCreate.yaml"
     400:
       description: "Bad Request"
-put:
-  summary: "Stop Migration"
-  description: |
-    Stop an ongoing Workload Migration.
-  operationId: "oceanAwsPutMigration"
-  tags:
-    - "Ocean AWS"
-  parameters:
-    - $ref: "../../../../commons/parameters/accountId.yaml"
-    - $ref: "../../commons/parameters/oceanClusterId.yaml"
-    - in: "query"
-      name: "migrationId"
-      example: "owm-6e3819ae"
-      description: >
-        The migration identifier of a specific migration.
-      schema:
-        type: "string"
-      required: true
-  requestBody:
-    required: true
-    content:
-      application/json:
-        schema:
-          allOf:
-            - $ref: "../schemas/migration/oceanUpdateMigration.yaml"
-  responses:
-    200:
-      $ref: "../responses/migrationUpdate.yaml"
-    400:
-      description: "Bad Request"
 get:
   summary: "List Migrations summary"
   description: |

api/services/ocean/aws/paths/workloadMigrationStatus.yaml

@@ -13,5 +13,28 @@ get:
   responses:
     200:
       $ref: "../responses/migrationStatus.yaml"
+    400:
+      description: "Bad Request"
+put:
+  summary: "Stop Migration"
+  description: |
+    Stop an ongoing Workload Migration.
+  operationId: "oceanAwsPutMigration"
+  tags:
+    - "Ocean AWS"
+  parameters:
+    - $ref: "../../../../commons/parameters/accountId.yaml"
+    - $ref: "../../commons/parameters/oceanClusterId.yaml"
+    - $ref: "../parameters/migration/migrationId.yaml"
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          allOf:
+            - $ref: "../schemas/migration/oceanUpdateMigration.yaml"
+  responses:
+    200:
+      $ref: "../responses/migrationUpdate.yaml"
     400:
       description: "Bad Request"

api/services/ocean/aws/schemas/OceanLaunchSpecLaunchNodesRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - launchRequest
 properties:
   launchRequest:
     type: object

api/services/ocean/aws/schemas/detachInstancesRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - instancesToDetach
 properties:
   instancesToDetach:
     type: array

api/services/ocean/aws/schemas/importASG-launchSpecRequest.yaml

@@ -61,7 +61,7 @@ properties:
               type: string
               description: |
                 Set taint effect.
-              enum: [NoSchedule, PreferNoSchedule, NoExecute, PreferNoExecute]
+              enum: [NoSchedule, PreferNoSchedule, NoExecute]
         example:
           - key: taintKey
             value: taintValue

api/services/ocean/aws/schemas/importASGRequest.yaml

@@ -1,6 +1,6 @@
 type: object
 properties:
-  launchSpec:
+  cluster:
     type: object
     description: |
       The object specifying the configuration of the VNG.

api/services/ocean/aws/schemas/migration/oceanCreateMigration.yaml

@@ -11,7 +11,7 @@ properties:
       - shouldTerminateDrainedNodes
       - shouldEvictStandAlonePods
       - forcePodEvictionOnPdbFailure
-      - batchSize
+      - batchSizePercentage
     properties:
       instanceIds:
         type: array
@@ -34,7 +34,7 @@ properties:
         example: true
         description: >
           Ocean will force the Pod eviction from the instance, even if the distributed budget is not satisfied.
-      batchSize:
+      batchSizePercentage:
         type: integer
         example: 50
         description: |

api/services/ocean/aws/schemas/ocean-blockDeviceMappings.yaml

@@ -38,6 +38,10 @@ items:
         example: 1
       dynamicIops:
         type: object
+        required:
+          - baseSize
+          - resource
+          - sizePerResourceUnit
         description: |
           Set dynamic IOPS properties. When using this object, you cannot use the 'iops' object. You must use one or the other.
         properties:
@@ -48,7 +52,7 @@ items:
             example: 50
           resource:
             type: string
-            enum: [ CPU , MEMORY ]
+            enum: [ CPU , memory ]
             description: |
             example: "CPU"
           sizePerResourceUnit:
@@ -77,6 +81,7 @@ items:
         required:
           - baseSize
           - resource
+          - sizePerResourceUnit
         description: >
           Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
         properties:
@@ -87,6 +92,7 @@ items:
             example: 50
           resource:
             type: string
+            enum: [ CPU ]
             example: "CPU"
           sizePerResourceUnit:
             type: integer

api/services/ocean/aws/schemas/oceanCluster.yaml

@@ -6,6 +6,7 @@ required:
   - name
   - region
   - controllerClusterId
+  - compute
 properties:
   id:
     type: string

api/services/ocean/aws/schemas/oceanClusterLaunchSpec.yaml

@@ -140,6 +140,8 @@ properties:
     properties:
       tagSelector:
         type: object
+        required:
+          - tagKey
         description: |
           Key-value object, which defines an Elastic IP from the customer pool. Can be null.
         properties:
@@ -283,6 +285,7 @@ properties:
               required:
                 - baseSize
                 - resource
+                - sizePerResourceUnit
               description: |
                 Set dynamic volume size properties. When using this object, you cannot use volumeSize.\
                 You must use one or the other.

api/services/ocean/aws/schemas/oceanClusterUpdate.yaml

@@ -2,9 +2,6 @@ type: object
 description: >
   The object specifying the configuration of the Ocean cluster.
 title: AWS Cluster
-required:
-  - name
-  - controllerClusterId
 properties:
   id:
     type: string

api/services/ocean/commons/parameters/limitParam.yaml

@@ -1,5 +1,5 @@
 in: "query"
-name: "LIMIT"
+name: "limit"
 description: >
   Maximum number of lines to extract in a response.
 schema:

api/services/ocean/commons/parameters/severityParam.yaml

@@ -1,5 +1,5 @@
 in: "query"
-name: "SEVERITY"
+name: "severity"
 description: >
   Severity of log entries to extract.
 schema:
@@ -8,6 +8,7 @@ schema:
     - ALL
     - INFO
     - DEBUG
+    - ERROR
     - WARN
   default: ALL
 required: false