Added endpoint for cancelling a job

DANS-KNAW · Jan 2, 2025 · 9618429 · 9618429
1 parent 4c4aa07
commit 9618429
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/src/main/openapi/dd-dataverse-ingest-api.yml b/src/main/openapi/dd-dataverse-ingest-api.yml
@@ -87,6 +87,33 @@ paths:
                 items:
                   $ref: '#/components/schemas/ImportJobStatus'
 
+  /ingest/cancel:
+    post:
+      parameters:
+        - name: path
+          in: query
+          description: The path of the job to cancel
+          required: false
+          schema:
+            type: string
+            format: path
+        - name: migration
+          in: query
+          description: Whether this is a migration import from EASY
+          required: false
+          schema:
+            type: boolean
+      summary: Cancel an ingest job
+      responses:
+        '202':
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ImportJobStatus'
+
 components:
   schemas:
     ImportCommand: