spec

Author: prkhrkat

specs/default-template-values.yaml

@@ -23,13 +23,47 @@ paths:
           schema:
             type: integer
           description: The chart reference ID
+        - name: token
+          in: header
+          required: true
+          schema:
+            type: string
+          description: Authentication token
       responses:
         '200':
           description: Successfully retrieved default template values
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DefaultTemplateResponse'
+                type: object
+                properties:
+                  code:
+                    type: integer
+                    description: HTTP status code
+                  status:
+                    type: string
+                    description: Status message
+                  result:
+                    type: object
+                    properties:
+                      appOverride:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            Key:
+                              type: string
+                              description: The configuration key
+                            Value:
+                              type: string
+                              description: The configuration value
+                      isAppMetricsEnabled:
+                        type: boolean
+                        description: Whether application metrics are enabled
+                  errors:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ApiError'
         '400':
           description: Bad request
           content:
@@ -57,21 +91,21 @@ paths:
 
 components:
   schemas:
-    DefaultTemplateResponse:
+    ApiError:
       type: object
       properties:
-        appOverride:
-          type: array
-          items:
-            type: object
-            properties:
-              Key:
-                type: string
-                description: The configuration key
-              Value:
-                type: string
-                description: The configuration value
-          description: Template configuration in key-value pairs
+        code:
+          type: string
+          description: Error code
+        message:
+          type: string
+          description: Error message
+        internalMessage:
+          type: string
+          description: Internal error message for debugging
+        userMessage:
+          type: string
+          description: User-friendly error message
 
     Error:
       type: object

specs/deployment_app_type_change_api.yaml

@@ -10,7 +10,7 @@ paths:
         description: A JSON object containing environment id and desired deployment app type
         required: true
         content:
-          text/plain:
+          application/json:
             schema:
               $ref: '#/components/schemas/DeploymentAppTypeChangeRequest'
       responses:
@@ -23,9 +23,9 @@ paths:
         '401':
           description: unauthorized user
           content:
-            text/plain:
+            application/json:
               schema:
-                type: string
+                $ref: '#/components/schemas/Error'
         '400':
           description: Bad Request. Validation error/wrong request body.
           content:
@@ -40,72 +40,106 @@ paths:
                 $ref: '#/components/schemas/Error'
         '403':
           description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
 # components mentioned below
 components:
   schemas:
     DeploymentAppTypeChangeRequest:
       type: object
+      required:
+        - envId
+        - desiredDeploymentType
       properties:
         envId:
           type: integer
           description: Environment id
         desiredDeploymentType:
           type: string
           description: Desired deployment type. For eg argo_cd / helm
+          enum: [argo_cd, helm]
         excludeApps:
           type: array
+          items:
+            type: integer
           description: List of app ids to be excluded
         includeApps:
           type: array
+          items:
+            type: integer
           description: List of app ids to be included (deployment will be changed only for these apps)
+        autoTriggerDeployment:
+          type: boolean
+          description: Whether to automatically trigger deployment after type change
+        userId:
+          type: integer
+          format: int32
+          description: User ID who initiated the change
     DeploymentChangeStatus:
       type: object
       properties:
-        id:
+        pipelineId:
+          type: integer
+          description: CD pipeline id
+        installedAppId:
           type: integer
-          description: cd pipeline id
+          description: Installed app id (for chart store apps)
+        appId:
+          type: integer
+          description: App id
         appName:
           type: string
-          description: app name
+          description: App name
+        envId:
+          type: integer
+          description: Environment id
         envName:
           type: string
-          description: environment name
+          description: Environment name
         error:
           type: string
           description: Error message if failed to change deployment app type
         status:
           type: string
-          description: If deployment change was successful or failed for this pipeline
+          description: Status of deployment change
+          enum: [Success, Failed, INITIATED, NOT_YET_DELETED, permission denied]
     DeploymentAppTypeChangeResponse:
       type: object
       properties:
         envId:
           type: integer
-          description: environment id
+          description: Environment id
         desiredDeploymentType:
           type: string
-          description: Desired deployment type. For eg argo_cd / helm
+          description: Desired deployment type
+          enum: [argo_cd, helm]
         successfulPipelines:
           type: array
-          description: Pipelines which were successfully deleted from current deployment
+          description: Pipelines which were successfully changed
           items:
-            $ref: '#components/schemas/DeploymentChangeStatus'
+            $ref: '#/components/schemas/DeploymentChangeStatus'
         failedPipelines:
           type: array
-          description: Pipelines which failed to get deleted from current deployment
+          description: Pipelines which failed to change deployment app type
           items:
-            $ref: '#components/schemas/DeploymentChangeStatus'
-    TriggeredPipelineDetails:
-      type: object
-      properties:
-        ciArtifactId:
-          type: integer
-          description: Artifact id deployed
-        pipelineId:
-          type: integer
-          description: Pipeline id for which deployment was triggered
+            $ref: '#/components/schemas/DeploymentChangeStatus'
+        triggeredPipelines:
+          type: array
+          description: Pipelines for which deployment was triggered
+          items:
+            type: object
+            properties:
+              ciArtifactId:
+                type: integer
+                description: CI artifact id
+              pipelineId:
+                type: integer
+                description: Pipeline id
     OkResponse:
+      type: object
       required:
         - code
         - status
@@ -114,26 +148,30 @@ components:
         code:
           type: integer
           format: int32
-          description: Error code
+          description: HTTP status code
         status:
           type: string
-          description: Error message
+          description: Status message
         result:
-          type: object
-          description: DeploymentAppTypeChangeResponse object
+          $ref: '#/components/schemas/DeploymentAppTypeChangeResponse'
     Error:
+      type: object
       required:
         - code
-        - status
+        - message
       properties:
         code:
-          type: integer
-          format: int32
-          description: Error internal code
+          type: string
+          description: Error code
+          example: E100
+        message:
+          type: string
+          description: Error message
+          example: User is not authenticated
         internalMessage:
           type: string
-          description: Error internal message
+          description: Internal error message for debugging
         userMessage:
           type: string
-          description: Error user message
+          description: User-friendly error message
 

specs/dynamic-handling-of-charts.yaml

@@ -12,27 +12,27 @@ paths:
       operationId: ChartRefAutocompleteForApp
       parameters:
         - name: appId
-          in: query
+          in: path
           required: true
           schema:
-            type: string
+            type: integer
+            description: Application ID
       responses:
         '200':
           description: Successfully return all charts
           content:
             application/json:
               schema:
+                type: object
                 properties:
                   code:
                     type: integer
-                    description: status code
+                    description: HTTP status code
                   status:
                     type: string
-                    description: status
+                    description: Status message
                   result:
-                    type: array
-                    items:
-                      $ref: '#/components/schemas/ChartRefResponse'
+                    $ref: '#/components/schemas/ChartRefAutocompleteResponse'
         '400':
           description: Bad Request. Input Validation error/wrong request body.
           content:
@@ -54,35 +54,79 @@ paths:
 
 components:
   schemas:
-    ChartRefResponse:
+    ChartRefAutocompleteResponse:
       type: object
       properties:
         chartRefs:
           type: array
           items:
-            $ref: '#/components/schemas/ChartRef'
+            $ref: '#/components/schemas/ChartRefAutocompleteDto'
         latestChartRef:
           type: integer
+          description: ID of the latest chart reference
         latestAppChartRef:
           type: integer
+          description: ID of the latest chart reference for the application
         latestEnvChartRef:
           type: integer
+          description: ID of the latest chart reference for the environment
         chartMetadata:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/ChartRefMetaData'
+          description: Map of chart name to metadata
+        compatibleChartTypes:
           type: array
           items:
-           type: string
-    ChartRef:
+            type: string
+          description: List of compatible chart types
+
+    ChartRefAutocompleteDto:
       type: object
       properties:
         id:
           type: integer
+          description: Chart reference ID
         version:
           type: string
+          description: Chart version
         name:
           type: string
+          description: Chart name
         description:
           type: string
+          description: Chart description
         userUploaded:
           type: boolean
+          description: Whether the chart was uploaded by a user
         isAppMetricsSupported:
-          type: boolean
+          type: boolean
+          description: Whether the chart supports application metrics
+
+    ChartRefMetaData:
+      type: object
+      properties:
+        chartDescription:
+          type: string
+          description: Description of the chart
+
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: string
+          description: Error code
+          example: E100
+        message:
+          type: string
+          description: Error message
+          example: User is not authenticated
+        internalMessage:
+          type: string
+          description: Internal error message for debugging
+        userMessage:
+          type: string
+          description: User-friendly error message