fix(specs): ingestion docker task input (#3488)

algolia · Aug 7, 2024 · 6c62a81 · 6c62a81
1 parent 41a6f11
commit 6c62a81
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 2 deletions.
diff --git a/specs/ingestion/common/schemas/task.yml b/specs/ingestion/common/schemas/task.yml
@@ -460,10 +460,34 @@ DockerStreamsInput:
   type: object
   properties:
     streams:
-      type: object
+      type: array
+      items: 
+        $ref: '#/DockerStreams'
   required:
     - streams
 
+DockerStreams:
+  type: object
+  properties:
+    name:
+      type: string
+      description: The name of the stream to fetch the data from (e.g. table name).
+    properties:
+      type: array
+      description: The properties of the stream to select (e.g. column).
+      items:
+        type: string
+    syncMode:
+      $ref: '#/DockerStreamsSyncMode'
+  required:
+    - name
+    - syncMode
+
+DockerStreamsSyncMode:
+  type: string
+  description: The strategy to use to fetch the data.
+  enum: [incremental, fullTable]
+
 failureThreshold:
   type: integer
   minimum: 0

diff --git a/specs/ingestion/paths/transformations/transformationsTry.yml b/specs/ingestion/paths/transformations/transformationsTry.yml
@@ -3,7 +3,7 @@ post:
     - transformations
   summary: Try a transformation
   description: Try a transformation.
-  operationId: tryTransformations
+  operationId: tryTransformation
   x-acl:
     - addObject
     - deleteIndex

diff --git a/tests/CTS/requests/ingestion/createTask.json b/tests/CTS/requests/ingestion/createTask.json
@@ -34,5 +34,40 @@
         "action": "replace"
       }
     }
+  },
+  {
+    "testName": "task shopify",
+    "parameters": {
+      "sourceID": "search",
+      "destinationID": "destinationName",
+      "cron": "* * * * *",
+      "action": "replace",
+      "input": {
+        "streams": [
+          {
+            "name": "foo",
+            "syncMode": "incremental"
+          }
+        ]
+      }
+    },
+    "request": {
+      "path": "/2/tasks",
+      "method": "POST",
+      "body": {
+        "sourceID": "search",
+        "destinationID": "destinationName",
+        "cron": "* * * * *",
+        "action": "replace",
+        "input": {
+          "streams": [
+            {
+              "name": "foo",
+              "syncMode": "incremental"
+            }
+          ]
+        }
+      }
+    }
   }
 ]
diff --git a/tests/CTS/requests/ingestion/createTaskV1.json b/tests/CTS/requests/ingestion/createTaskV1.json
@@ -69,5 +69,44 @@
         "action": "replace"
       }
     }
+  },
+  {
+    "testName": "task shopify",
+    "parameters": {
+      "sourceID": "search",
+      "destinationID": "destinationName",
+      "trigger": {
+        "type": "onDemand"
+      },
+      "action": "replace",
+      "input": {
+        "streams": [
+          {
+            "name": "foo",
+            "syncMode": "incremental"
+          }
+        ]
+      }
+    },
+    "request": {
+      "path": "/1/tasks",
+      "method": "POST",
+      "body": {
+        "sourceID": "search",
+        "destinationID": "destinationName",
+        "trigger": {
+          "type": "onDemand"
+        },
+        "action": "replace",
+        "input": {
+          "streams": [
+            {
+              "name": "foo",
+              "syncMode": "incremental"
+            }
+          ]
+        }
+      }
+    }
   }
 ]
diff --git a/...equests/ingestion/tryTransformations.json → ...requests/ingestion/tryTransformation.json b/...equests/ingestion/tryTransformations.json → ...requests/ingestion/tryTransformation.json