feat(ingestion): add put task endpoint

Author: shortcuts

specs/ingestion/common/schemas/task.yml

@@ -179,10 +179,41 @@ TaskCreateResponse:
     - taskID
     - createdAt
 
-TaskUpdate:
+TaskFullUpdate:
   type: object
   additionalProperties: false
   description: API request body for updating a task.
+  properties:
+    destinationID:
+      $ref: './common.yml#/destinationID'
+    action:
+      $ref: '#/ActionType'
+    subscriptionAction:
+      $ref: '#/ActionType'
+    cron:
+      $ref: '#/Cron'
+    enabled:
+      type: boolean
+      description: Whether the task is enabled.
+    failureThreshold:
+      $ref: '#/failureThreshold'
+    input:
+      $ref: '#/TaskInput'
+    cursor:
+      $ref: './common.yml#/cursor'
+    notifications:
+      $ref: '#/Notifications'
+    policies:
+      $ref: '#/Policies'
+  required:
+    - destinationID
+    - action
+
+# TODO: rename TaskUpdate to TaskPartialUpdate next major
+TaskUpdate:
+  type: object
+  additionalProperties: false
+  description: API request body for partially updating a task.
   properties:
     destinationID:
       $ref: './common.yml#/destinationID'
@@ -215,8 +246,7 @@ TaskUpdateV1:
     input:
       $ref: '#/TaskInput'
     enabled:
-      type: boolean
-      description: Whether the task is enabled.
+      $ref: '#/Enabled'
     failureThreshold:
       $ref: '#/failureThreshold'
 
@@ -309,6 +339,10 @@ Cron:
   description: Cron expression for the task's schedule.
   example: '* * 1 * *'
 
+Enabled:
+  type: boolean
+  description: Whether the task is enabled.
+
 ScheduleTriggerType:
   type: string
   description: Task runs on a schedule.

specs/ingestion/paths/tasks/v2/taskID.yml

@@ -20,11 +20,36 @@ get:
     '400':
       $ref: '../../../../common/responses/BadRequest.yml'
 
+put:
+  tags:
+    - tasks
+  summary: Fully updates a task
+  description: Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+  operationId: fullUpdateTask
+  parameters:
+    - $ref: '../../../common/parameters.yml#/pathTaskID'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../../common/schemas/task.yml#/TaskFullUpdate'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
+    '400':
+      $ref: '../../../../common/responses/BadRequest.yml'
+
+# TODO: rename taskUpdate to taskPartialUpdate next major
 patch:
   tags:
     - tasks
-  summary: Update a task
-  description: Updates a task by its ID.
+  summary: Partially updates a task
+  description: Partially updates a task by its ID.
   operationId: updateTask
   parameters:
     - $ref: '../../../common/parameters.yml#/pathTaskID'

tests/CTS/requests/ingestion/createTask.json

@@ -3,15 +3,15 @@
     "testName": "task without cron",
     "parameters": {
       "sourceID": "search",
-      "destinationID": "destinationName",
+      "destinationID": "destinationID",
       "action": "replace"
     },
     "request": {
       "path": "/2/tasks",
       "method": "POST",
       "body": {
         "sourceID": "search",
-        "destinationID": "destinationName",
+        "destinationID": "destinationID",
         "action": "replace"
       }
     }
@@ -20,7 +20,7 @@
     "testName": "task with cron",
     "parameters": {
       "sourceID": "search",
-      "destinationID": "destinationName",
+      "destinationID": "destinationID",
       "cron": "* * * * *",
       "action": "replace",
       "notifications": {
@@ -37,7 +37,7 @@
       "method": "POST",
       "body": {
         "sourceID": "search",
-        "destinationID": "destinationName",
+        "destinationID": "destinationID",
         "cron": "* * * * *",
         "action": "replace",
         "notifications": {
@@ -55,7 +55,7 @@
     "testName": "task shopify",
     "parameters": {
       "sourceID": "search",
-      "destinationID": "destinationName",
+      "destinationID": "destinationID",
       "cron": "* * * * *",
       "action": "replace",
       "input": {
@@ -72,7 +72,7 @@
       "method": "POST",
       "body": {
         "sourceID": "search",
-        "destinationID": "destinationName",
+        "destinationID": "destinationID",
         "cron": "* * * * *",
         "action": "replace",
         "input": {

tests/CTS/requests/ingestion/fullUpdateTask.json

@@ -0,0 +1,87 @@
+[
+  {
+    "testName": "task without cron",
+    "parameters": {
+      "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "destinationID": "destinationID",
+      "action": "replace"
+    },
+    "request": {
+      "path": "/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "method": "POST",
+      "body": {
+        "destinationID": "destinationID",
+        "action": "replace"
+      }
+    }
+  },
+  {
+    "testName": "task with cron",
+    "parameters": {
+      "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "destinationID": "destinationID",
+      "cron": "* * * * *",
+      "action": "replace",
+      "notifications": {
+        "email": {
+          "enabled": true
+        }
+      },
+      "policies": {
+        "criticalThreshold": 8
+      }
+    },
+    "request": {
+      "path": "/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "method": "POST",
+      "body": {
+        "destinationID": "destinationID",
+        "cron": "* * * * *",
+        "action": "replace",
+        "notifications": {
+          "email": {
+            "enabled": true
+          }
+        },
+        "policies": {
+          "criticalThreshold": 8
+        }
+      }
+    }
+  },
+{
+    "testName": "task shopify",
+    "parameters": {
+      "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "destinationID": "destinationID",
+      "cron": "* * * * *",
+      "action": "replace",
+      "input": {
+        "streams": [
+          {
+            "name": "foo",
+            "syncMode": "incremental"
+          }
+        ]
+      }
+    },
+    "request": {
+      "path": "/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "method": "POST",
+      "body": {
+        "sourceID": "search",
+        "destinationID": "destinationID",
+        "cron": "* * * * *",
+        "action": "replace",
+        "input": {
+          "streams": [
+            {
+              "name": "foo",
+              "syncMode": "incremental"
+            }
+          ]
+        }
+      }
+    }
+  }
+]