feat: added abort api endpoint (MAPCO-8328)

.github/workflows/pull_request.yaml

@@ -6,5 +6,4 @@ jobs:
   pull_request:
     uses: MapColonies/shared-workflows/.github/workflows/pull_request.yaml@v5
     secrets: inherit
-    with:
-      chartDirs: 'helm'
+

config/custom-environment-variables.json

@@ -87,6 +87,7 @@
     "jobDomain": "JOB_DOMAIN",
     "ingestionNewJobType": "INGESTION_NEW_JOB_TYPE",
     "validationTaskType": "VALIDATION_TASK_TYPE",
+    "finalizeTaskType": "FINALIZE_TASK_TYPE",
     "ingestionUpdateJobType": "INGESTION_UPDATE_JOB_TYPE",
     "ingestionSwapUpdateJobType": "INGESTION_SWAP_UPDATE_JOB_TYPE",
     "supportedIngestionSwapTypes": {

config/default.json

@@ -63,6 +63,7 @@
     "ingestionUpdateJobType": "Ingestion_Update",
     "ingestionSwapUpdateJobType": "Ingestion_Swap_Update",
     "validationTaskType": "validation",
+    "finalizeTaskType": "finalize",
     "supportedIngestionSwapTypes": [
       {
         "productType": "RasterVectorBest",

helm/templates/configmap.yaml

@@ -37,6 +37,7 @@ data:
   INGESTION_UPDATE_JOB_TYPE: {{ $jobDefinitions.jobs.update.type | quote }}
   INGESTION_SWAP_UPDATE_JOB_TYPE: {{ $jobDefinitions.jobs.swapUpdate.type | quote }}
   VALIDATION_TASK_TYPE: {{ $jobDefinitions.tasks.validation.type | quote }}
+  FINALIZE_TASK_TYPE: {{ $jobDefinitions.tasks.finalize.type | quote }}
   CRS: {{ .Values.env.validationValuesByInfo.crs | toJson | quote}}
   FILE_FORMAT: {{ .Values.env.validationValuesByInfo.fileFormat | toJson | quote}}
   TILE_SIZE: {{ .Values.env.validationValuesByInfo.tileSize | quote}}

helm/values.yaml

@@ -55,6 +55,8 @@ jobDefinitions:
   tasks:
     validation:
       type: ""
+    finalize:
+      type: ""
 
 storage:
   fs:

openapi3.yaml

@@ -50,7 +50,7 @@ paths:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
         '500':
-          description: Server error
+          description: Internal Server Error
           content:
             application/json:
               schema:
@@ -111,7 +111,7 @@ paths:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
         '500':
-          description: Invalid request
+          description: Internal Server Error
           content:
             application/json:
               schema:
@@ -157,8 +157,69 @@ paths:
               schema:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+        '422':
+          description: Unprocessable Content
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
         '500':
-          description: Internal Server error
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+  /ingestion/{jobId}/abort:
+    put:
+      operationId: abortIngestion
+      tags:
+        - ingestion
+      summary: abort an active ingestion job
+      description: >-
+        Aborts an ingestion job that is currently active or pending, preventing any further processing.
+      parameters:
+        - name: jobId
+          in: path
+          description: The id of the job to abort
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK - Job aborted successfully
+        '400':
+          description: Bad request - Job status does not allow abort (COMPLETED or ABORTED)
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+        '404':
+          description: Not Found - Job does not exist
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+        '409':
+          description: Conflict - Unable to abort job due to current state (e.g., already completed or in finalization)
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+        '422':
+          description: Unprocessable Content
+          content:
+            application/json:
+              schema:
+                $ref: >-
+                  ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+        '500':
+          description: Internal Server Error
           content:
             application/json:
               schema:
@@ -188,7 +249,7 @@ paths:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/validateSourcesResponse
         '400':
-          description: Invalid request
+          description: Bad Request
           content:
             application/json:
               schema:
@@ -230,7 +291,7 @@ paths:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/sourcesInfoResponse
         '400':
-          description: Invalid request
+          description: Bad Request
           content:
             application/json:
               schema:
@@ -257,6 +318,7 @@ paths:
               schema:
                 $ref: >-
                   ./Schema/ingestionTrigger/responses/ingestionTriggerResponses.yaml#/components/schemas/errorMessage
+
 components:
   schemas:
     CallbackUrls: