g

Author: prkhrkat

specs/bulk_update.yaml

@@ -26,7 +26,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/BulkUpdateSeeExampleResponse'
+                type: array
+                items:
+                  $ref: '#/components/schemas/BulkUpdateSeeExampleResponse'
         '500':
           description: Internal Server Error
           content:
@@ -50,9 +52,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/ImpactedObjectsResponse'
+                $ref: '#/components/schemas/ImpactedObjectsResponse'
         '400':
           description: Bad Request. Validation error/wrong request body.
           content:
@@ -115,7 +115,7 @@ components:
       required:
         - Script
       properties:
-        resource:
+        operation:
           type: string
           description: Resource from url path, i.e. {apiVersion} & {kind}
         script:
@@ -158,41 +158,43 @@ components:
         global:
           type: boolean
           description: Global flag for updating dependent apps
-        DeploymentTemplate:
+        deploymentTemplate:
           $ref: '#/components/schemas/Tasks'
-        ConfigMaps:
-          type: object
-          properties:
-            names:
-              type: array
-              items:
-                type: string
-                description : Name of All ConfigMaps to be updated
-            tasks:
-              $ref: '#/components/schemas/Spec'
-        Secrets:
-          type: object
-          properties:
-            names:
-              type: array
-              items:
-                type: string
-                description : Name of All Secrets to be updated
-            tasks:
-              $ref: '#/components/schemas/Spec'
+        configMap:
+          $ref: '#/components/schemas/CmAndSecret'
+        secret:
+          $ref: '#/components/schemas/CmAndSecret'
     Tasks:
       type: object
       properties:
         spec:
           $ref: '#/components/schemas/Spec'
           description: Spec of the Task
+    CmAndSecret:
+      type: object
+      properties:
+        spec:
+          $ref: '#/components/schemas/CmAndSecretSpec'
+          description: Spec of the ConfigMap/Secret
+    CmAndSecretSpec:
+      type: object
+      required:
+        - names
+      properties:
+        names:
+          type: array
+          items:
+            type: string
+          description: Names of all configmaps/secrets to be updated
+        patchData:
+          type: string
+          description: string with details of the patch to be used for updating
     Spec:
       type: object
       properties:
         patchData:
           type: string
           description: string with details of the patch to be used for updating
-
     NameIncludesExcludes:
       type: object
       properties:
@@ -249,91 +251,58 @@ components:
       type: object
       properties:
         deploymentTemplate:
-          $ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponse'
-        configMap:
-          $ref: '#/components/schemas/CmAndSecretBulkUpdateResponse'
-        secret:
-          $ref: '#/components/schemas/CmAndSecretBulkUpdateResponse'
-    DeploymentTemplateBulkUpdateResponse:
-      type: object
-      properties:
-        message:
-          type: array
-          items:
-            type: string
-          description: All top-level messages in response of bulk update action
-        failure:
           type: array
           items:
             $ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponseForOneApp'
-          description: Details of all apps on which bulk update failed
-        successful:
-          type: array
-          items:
-            $ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponseForOneApp'
-          description: Details of all apps on which bulk update applied successfully
-    CmAndSecretBulkUpdateResponse:
-      type: object
-      properties:
-        message:
-          type: array
-          items:
-            type: string
-          description: All top-level messages in response of bulk update action
-        failure:
+        configMap:
           type: array
           items:
             $ref: '#/components/schemas/CmAndSecretBulkUpdateResponseForOneApp'
-          description: Details of all apps on which bulk update failed
-        successful:
+        secret:
           type: array
           items:
             $ref: '#/components/schemas/CmAndSecretBulkUpdateResponseForOneApp'
-          description: Details of all apps on which bulk update applied successfully
     DeploymentTemplateBulkUpdateResponseForOneApp:
       type: object
       properties:
         appId:
           type: integer
-          description: Id of the concerned app
+          description: Id of the impacted app
         appName:
           type: string
-          description: Name of the concerned app
+          description: Name of the impacted app
         envId:
-          type: integer
-          description: Env ID of the concerned app
+          type: string
+          description: Env Id of the impacted app
         message:
           type: string
-          description: App-level message for the concerned app
+          description: Message indicating success or failure of the update
     CmAndSecretBulkUpdateResponseForOneApp:
       type: object
       properties:
         appId:
           type: integer
-          description: Id of the concerned app
+          description: Id of the impacted app
         appName:
           type: string
-          description: Name of the concerned app
+          description: Name of the impacted app
         envId:
-          type: integer
-          description: Env ID of the concerned app
+          type: string
+          description: Env Id of the impacted app
         names:
           type: array
           items:
             type: string
-          description: Names of all configmaps/secrets
+          description: Names of all configmaps/secrets impacted
         message:
           type: string
-          description: App-level message for the concerned app
-
+          description: Message indicating success or failure of the update
     Error:
-      required:
-        - code
-        - message
+      type: object
       properties:
         code:
           type: integer
-          description: Error code
+          description: HTTP status code
         message:
           type: string
           description: Error message