specs

Author: prkhrkat

specs/fluxcd_app.yaml

@@ -33,7 +33,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-
         '403':
           description: Forbidden
           content:
@@ -48,48 +47,47 @@ paths:
                 $ref: '#/components/schemas/Error'
 
   /orchestrator/flux-application/app:
-      get:
-        summary: Get application details
-        description: Retrieve details of a specific Flux application.
-        parameters:
-          - name: appId
-            in: query
-            required: true
-            schema:
-              type: string
-            description: The application identifier in the format "1|default|myksApp|Kustomization as the first field having  the cluster id, then second field having the namespace of the app , third field denoted the app name and last contains a boolean value of true and false".
-          - name: token
-            in: header
-            required: true
-            schema:
-              type: string
-            description: The authentication token.
-        responses:
-          '200':
-            description: Successful response
-            content:
-              application/json:
-                schema:
-                  $ref: '#/components/schemas/FluxApplicationDetailDto'
-          '400':
-            description: Bad request
-            content:
-              application/json:
-                schema:
-                  $ref: '#/components/schemas/Error'
-          '403':
-            description: Forbidden
-            content:
-              application/json:
-                schema:
-                  $ref: '#/components/schemas/Error'
-          '500':
-            description: Internal server error
-            content:
-              application/json:
-                schema:
-                  $ref: '#/components/schemas/Error'
-
+    get:
+      summary: Get application details
+      description: Retrieve details of a specific Flux application.
+      parameters:
+        - name: appId
+          in: query
+          required: true
+          schema:
+            type: string
+          description: The application identifier in the format "clusterId|namespace|appName|isKustomizeApp" where isKustomizeApp is a boolean value indicating if the app is a Kustomization type.
+        - name: token
+          in: header
+          required: true
+          schema:
+            type: string
+          description: The authentication token.
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FluxApplicationDetailDto'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
 components:
   schemas:
@@ -107,6 +105,13 @@ components:
           description: List of Flux applications
           items:
             $ref: '#/components/schemas/FluxAppDto'
+        errored:
+          type: boolean
+          description: Whether there was an error fetching the applications
+        errorMsg:
+          type: string
+          description: Error message if any
+
     FluxAppDto:
       type: object
       properties:
@@ -116,9 +121,8 @@ components:
           example: flux-system
         appStatus:
           type: boolean
-          enum: [True, False]
-          description:
-          example: True
+          description: Health status of the application
+          example: true
         syncStatus:
           type: string
           description: Sync status of the application
@@ -137,9 +141,21 @@ components:
           example: flux-system
         fluxAppDeploymentType:
           type: string
-          enum": ["Kustomization", "HelmRelease"]
+          enum: ["Kustomization", "HelmRelease"]
           description: Indicates if the application is a Kustomize type or standalone flux made HelmRelease app
-          example: true
+          example: "Kustomization"
+
+    FluxApplicationDetailDto:
+      type: object
+      allOf:
+        - $ref: '#/components/schemas/FluxAppDto'
+        - type: object
+          properties:
+            fluxAppStatusDetail:
+              $ref: '#/components/schemas/FluxAppStatusDetail'
+            resourceTree:
+              $ref: '#/components/schemas/ResourceTreeResponse'
+
     FluxAppStatusDetail:
       type: object
       properties:
@@ -153,29 +169,46 @@ components:
           type: string
           description: Short key words like 'ReconciliationFailed', 'Reconciled', and so on for the user to understand the reason of the given of the status
 
-    InfoItem:
+    ResourceTreeResponse:
       type: object
       properties:
-        name:
-          type: string
-        value:
+        nodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/ResourceNode'
+        pods:
+          type: array
+          items:
+            $ref: '#/components/schemas/PodMetadata'
+        status:
           type: string
+          description: Status of the resource tree
 
-    HealthStatus:
+    ResourceNode:
       type: object
       properties:
-        status:
+        group:
           type: string
-        message:
+        version:
           type: string
-
-    ResourceNetworkingInfo:
-      type: object
-      properties:
-        labels:
-          type: object
-          additionalProperties:
-            type: string
+        kind:
+          type: string
+        namespace:
+          type: string
+        name:
+          type: string
+        uid:
+          type: string
+        parentRefs:
+          type: array
+          items:
+            $ref: '#/components/schemas/ResourceRef'
+        networkingInfo:
+          $ref: '#/components/schemas/ResourceNetworkingInfo'
+        resourceVersion:
+          type: string
+        health:
+          $ref: '#/components/schemas/HealthStatus'
 
     ResourceRef:
       type: object
@@ -193,6 +226,14 @@ components:
         uid:
           type: string
 
+    ResourceNetworkingInfo:
+      type: object
+      properties:
+        labels:
+          type: object
+          additionalProperties:
+            type: string
+
     PodMetadata:
       type: object
       properties:
@@ -223,77 +264,18 @@ components:
         isExternal:
           type: boolean
 
-    ResourceNode:
+    HealthStatus:
       type: object
       properties:
-        group:
-          type: string
-        version:
-          type: string
-        kind:
-          type: string
-        namespace:
-          type: string
-        name:
-          type: string
-        uid:
-          type: string
-        parentRefs:
-          type: array
-          items:
-            $ref: '#/components/schemas/ResourceRef'
-        networkingInfo:
-          $ref: '#/components/schemas/ResourceNetworkingInfo'
-        resourceVersion:
-          type: string
-        health:
-          $ref: '#/components/schemas/HealthStatus'
-        isHibernated:
-          type: boolean
-        canBeHibernated:
-          type: boolean
-        info:
-          type: array
-          items:
-            $ref: '#/components/schemas/InfoItem'
-        createdAt:
+        status:
           type: string
-          format: date-time
-        port:
-          type: array
-          items:
-            type: integer
-        isHook:
-          type: boolean
-        hookType:
+        message:
           type: string
 
-    ResourceTreeResponse:
-      type: object
-      properties:
-        nodes:
-          type: array
-          items:
-            $ref: '#/components/schemas/ResourceNode'
-        podMetadata:
-          type: array
-          items:
-            $ref: '#/components/schemas/PodMetadata'
-
-    FluxApplicationDetailDto:
-      type: object
-      properties:
-        FluxApplication:
-          $ref: '#/components/schemas/FluxAppDto'
-        FluxAppStatusDetail:
-          $ref: '#/components/schemas/FluxAppStatusDetail'
-        ResourceTreeResponse:
-          $ref: '#/components/schemas/ResourceTreeResponse'
-
     Error:
       type: object
       properties:
+        code:
+          type: string
         message:
           type: string
-          description: Error message
-          example: unauthorized

specs/image-tagging.yaml

@@ -11,8 +11,7 @@ paths:
         content:
           application/json:
             schema:
-              items:
-                $ref: "#/components/schemas/ImageTaggingRequestDTO"
+              $ref: "#/components/schemas/ImageTaggingRequestDTO"
       responses:
         "200":
           description: success on tags and comment creation for the given artifact.
@@ -34,7 +33,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#components/schemas/ImageTaggingResponseDTO"
+                $ref: "#/components/schemas/ImageTaggingResponseDTO"
         "500":
           description: will get this response if any failure occurs at server side.
         "403":
@@ -61,7 +60,11 @@ components:
         appReleaseTags:
           type: array
           items:
-            $ref: '#/components/schemas/ReleaseTag'
+            type: string
+            description: List of unique tag names in the app
+        hideImageTaggingHardDelete:
+          type: boolean
+          description: Whether hard delete of tags is hidden
 
 
 
@@ -109,15 +112,19 @@ components:
           items:
             $ref: '#/components/schemas/ReleaseTag'
           description: tag objects requested for creation
-        updateTags:
+        softDeleteTags:
+          type: array
+          items:
+            $ref: '#/components/schemas/ReleaseTag'
+          description: tag objects requested for soft deletion
+        hardDeleteTags:
           type: array
           items:
             $ref: '#/components/schemas/ReleaseTag'
-          description: tag objects requested for deletion
+          description: tag objects requested for hard deletion
         imageComment:
           type: object
-          items:
-            $ref: '#/components/schemas/ImageComment'
+          $ref: '#/components/schemas/ImageComment'
           description: image comment data