[src] cr changes

api/services/ocean/aws/responses/amiAutoUpdate.yaml

@@ -1,4 +1,5 @@
 description: Ocean Cluster Aggregated Summary Costs Response
+# todo shauli - Aggregated Summary Costs?
 content:
   application/json:
     schema:
@@ -11,6 +12,7 @@ content:
               properties:
                 url:
                   example: "/ocean/aws/k8s/cluster/o-abcd1234/aggregatedCosts/summary"
+                  # todo shauli - aggregatedCosts?
                 method:
                   example: "POST"
             response:

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

@@ -6,15 +6,15 @@ properties:
   patch:
     type: boolean
     description: > 
-      When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true
+      When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. Either "patch" or "minorVersion" must be true.
     example: "true"
     default: false
   minorVersion:
     type: boolean
     example: "true"
     default: false
     description: >
-      When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minorVersion" must be true.
+      When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. Either "patch" or "minorVersion" must be true.
   applyRoll:
     type: boolean
     example: "true"
@@ -27,16 +27,18 @@ properties:
     properties:
       batchSizePercentage:
         type: integer
-        description: Value as a percent to set the size of a batch in a roll. Valid values are 0-100..
+        description: Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
         example: 20
       batchMinHealthyPercentage:
         type: integer
-        description: Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch..
+        description: Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
         example: 100
+        #todo shauli - if default exist, add default field.
       comment:
         type: string
         description: >
           Add a brief description for the roll. The comment is limited to 256 chars.
         example: "This is why I rolled my cluster."
-
+    #todo shauli - what about respectPdb?
+    #todo shauli - if possible consider using reference to files under roll folder - let's discuss why that better.
 

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

@@ -39,4 +39,5 @@ properties:
      readOnly: true
      example: ami-019e5b81636e5a350
      description: |
-       The ID of the new AMI that is being used for the VNG.
+       The ID of the new AMI that is being used for the VNG.
+    #todo shauli - what will it show if it's double ami in the vng? or this is not relevant?

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

@@ -14,6 +14,7 @@ properties:
     description: >
       Ami update result.
     enum: [ Success, Failed ]
+    #todo shauli - verify lower-upper casing
   data:
     type: array
     items:
@@ -30,6 +31,7 @@ properties:
     example: 2024-01-02T09:57:09.211Z
     description: |
       The AMI update method was triggered at this time.
+    #todo shauli - not create method?
   updatedAt:
     type: string
     readOnly: true

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

@@ -28,12 +28,14 @@ properties:
         taskType:
           type: string
           example: clusterRoll / amiAutoUpdate
+          #todo shauli - why both of the enum in the example? there can be only one in a request
           enum: ["clusterRoll", "amiAutoUpdate"]
           description: >
             The activity that you are scheduling. Valid values: "clusterRoll", "amiAutoUpdate". Required for cluster.scheduling.tasks.
         parameters:
           type: object
           properties:
+            #todo shauli - clusterRoll tree object appears twice in here - verifying this is intentional
             clusterRoll:
               type: object
               properties:

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

@@ -1,4 +1,5 @@
 type: object
+# todo shauli  - typo in file name. who uses this file?
 description: >
   List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. 
   Cannot be configured together with whitelist/blacklist.