refact

Author: prkhrkat

specs/pipeline/ci-pipeline-build-spec.yaml

@@ -16,6 +16,56 @@ servers:
     description: Devtron Orchestrator API Server
 
 paths:
+  /orchestrator/app/ci-pipeline/{appId}/{ciPipelineId}:
+    get:
+      description: get CI pipeline details
+      operationId: GetCiPipeline
+      parameters:
+        - name: appId
+          in: path
+          required: true
+          schema:
+            type: integer
+        - name: ciPipelineId
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        '200':
+          description: Successfully get the pipeline config
+          content:
+            application/json:
+              schema:
+                properties:
+                  code:
+                    type: integer
+                    description: status code
+                  status:
+                    type: string
+                    description: status
+                  result:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/CiPipelineDto'
+        '400':
+          description: Bad Request. Input Validation error/wrong request body.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Unauthorized User
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
   /orchestrator/app/commit-info/{ciPipelineMaterialId}/{gitHash}:
     get:
       tags:
@@ -184,6 +234,338 @@ paths:
 
 components:
   schemas:
+    CiPipelineDto:
+      type: object
+      properties:
+        appId:
+          type: integer
+        action:
+          type: integer
+        appWorkflowId:
+          type: integer
+        ciPipeline:
+          $ref: '#/components/schemas/CiPipelineDetails'
+    CiPipelineDetails:
+      type: object
+      properties:
+        id:
+          type: integer
+        active:
+          type: boolean
+        isExternal:
+          type: boolean
+        isManual:
+          type: boolean
+        linkedCount:
+          type: integer
+        name:
+          type: string
+        scanEnabled:
+          type: boolean
+        dockerArgs:
+          type: array
+          items:
+            $ref: '#/components/schemas/DockerArg'
+        externalCiConfig:
+          $ref: '#/components/schemas/ExternalCiConfig'
+        ciMaterial:
+          $ref: '#/components/schemas/CiMaterial'
+        beforeDockerBuildScripts:
+          type: array
+          items:
+            $ref: '#/components/schemas/DockerBuildScript'
+        afterDockerBuildScripts:
+          type: array
+          items:
+            $ref: '#/components/schemas/DockerBuildScript'
+        preBuildStage:
+          $ref: '#/components/schemas/BuildStageDto'
+        postBuildStage:
+          $ref: '#/components/schemas/BuildStageDto'
+    DockerBuildScript:
+      type: object
+      properties:
+        id:
+          type: integer
+        index:
+          type: integer
+        name:
+          type: string
+        outputLocation:
+          type: string
+        script:
+          type: string
+    BuildStageDto:
+      type: object
+      properties:
+        id:
+          type: integer
+          description: pipelineStageId(every stage is given a Id)
+        steps:
+          type: array
+          items:
+            $ref: '#/components/schemas/stageStepDetails'
+    stageStepDetails:
+      type: object
+      properties:
+        id:
+          type: integer
+        index:
+          type: integer
+          description: sequence of step in all steps
+        name:
+          type: string
+        description:
+          type: string
+        stepType:
+          type: string
+          example:
+            - "INLINE"
+            - "REF_PLUGIN"
+        outputDirectoryPath:
+          type: array
+          items:
+            type: string
+        inlineStepDetail:
+          $ref: '#/components/schemas/InlineStepDetail'
+        pluginRefStepDetail:
+          $ref: '#/components/schemas/PluginRefStepDetail'
+    InlineStepDetail:
+      type: object
+      properties:
+        scriptType:
+          type: string
+          example:
+            - "SHELL"
+            - "DOCKERFILE"
+            - "CONTAINER_IMAGE"
+        script:
+          type: string
+        storeScriptAt:
+          type: string
+        dockerFileExists:
+          type: boolean
+        mountPath:
+          type: string
+        mountCodeToContainer:
+          type: boolean
+        mountCodeToContainerPath:
+          type: string
+        mountDirectoryFromHost:
+          type: boolean
+        containerImagePath:
+          type: string
+        imagePullSecretType:
+          type: string
+          example:
+            - "CONTAINER_REGISTRY"
+            - "SECRET_PATH"
+        imagePullSecret:
+          type: string
+        mountPathMap:
+          type: array
+          items:
+            $ref: '#/components/schemas/MountPathMap'
+        commandArgsMap:
+          type: array
+          items:
+            $ref: '#/components/schemas/CommandArgMap'
+        portMap:
+          type: array
+          items:
+            $ref: '#/components/schemas/PortMap'
+        inputVariables:
+          type: array
+          items:
+            $ref: '#/components/schemas/PipelineStepsVariableDto'
+        outputVariables:
+          type: array
+          items:
+            $ref: '#/components/schemas/PipelineStepsVariableDto'
+        conditionDetails:
+          type: array
+          items:
+            $ref: '#/components/schemas/ConditionDetail'
+    PluginRefStepDetail:
+      type: object
+      properties:
+        pluginId:
+          type: integer
+          description: id of the plugin used in the step
+        inputVariables:
+          type: array
+          items:
+            $ref: '#/components/schemas/PluginVariableDto'
+        outputVariables:
+          type: array
+          items:
+            $ref: '#/components/schemas/PluginVariableDto'
+        conditionDetails:
+          type: array
+          items:
+            $ref: '#/components/schemas/ConditionDetail'
+    PluginVariableDto:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Variable name
+        description:
+          type: string
+          description: Variable description
+        type:
+          type: string
+          description: Variable type
+        format:
+          type: string
+          description: Variable format
+        required:
+          type: boolean
+          description: Whether the variable is required
+        defaultValue:
+          type: string
+          description: Default value for the variable
+    PipelineStepsVariableDto:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        value:
+          type: integer
+        format:
+          type: string
+          example:
+            - "STRING"
+            - "NUMBER"
+            - "BOOL"
+            - "DATE"
+        description:
+          type: string
+        defaultValue:
+          type: string
+        refVariableUsed:
+          type: boolean
+        refVariableType:
+          type: string
+          example:
+            - "GLOBAL"
+            - "FROM_PREVIOUS_STEP"
+            - "NEW"
+        refVariableStepIndex:
+          type: integer
+        refVariableName:
+          type: string
+        refVariableStage:
+          type: string
+          example:
+            - "PRE_CI"
+            - "POST_CI"
+    ConditionDetail:
+      type: object
+      properties:
+        id:
+          type: integer
+        conditionOnVariable:
+          type: string
+          description: name of the variable on which condition is applied
+        conditionOperator:
+          type: string
+        conditionType:
+          type: string
+          example:
+            - "SKIP"
+            - "TRIGGER"
+            - "SUCCESS"
+            - "FAIL"
+        conditionalValue:
+          type: string
+    MountPathMap:
+      type: object
+      properties:
+        filePathOnDisk:
+          type: string
+        filePathOnContainer:
+          type: string
+    CommandArgMap:
+      type: object
+      properties:
+        command:
+          type: string
+        args:
+          type: array
+          items:
+            type: string
+    PortMap:
+      type: object
+      properties:
+        portOnLocal:
+          type: integer
+        portOnContainer:
+          type: integer
+    Error:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Error code
+        status:
+          type: string
+          description: Error status
+        errors:
+          type: array
+          items:
+            type: object
+            properties:
+              code:
+                type: integer
+                description: Error code
+              internalMessage:
+                type: string
+                description: Internal error message
+              userMessage:
+                type: string
+                description: User friendly error message
+    DockerArg:
+      type: object
+      description: map of key value pairs
+      properties:
+        key:
+          type: string
+        value:
+          type: string
+    ExternalCiConfig:
+      type: object
+      properties:
+        id:
+          type: integer
+        accessKey:
+          type: string
+        webhookUrl:
+          type: string
+        payload:
+          type: string
+    CiMaterial:
+      type: array
+      items:
+        $ref: '#/components/schemas/CiMaterialDetail'
+    CiMaterialDetail:
+      type: object
+      properties:
+        id:
+          type: integer
+        gitMaterialId:
+          type: integer
+        source:
+          type: object
+          properties:
+            type:
+              type: string
+              example: "SOURCE_TYPE_BRANCH_FIXED"
+            value:
+              type: string
+              example: "master"
     CommitInfo:
       type: object
       required: