feat(specs): add global push endpoint

Author: shortcuts

specs/ingestion/common/parameters.yml

@@ -83,3 +83,11 @@ orderKeys:
   description: Ascending or descending sort order.
   default: desc
   enum: [asc, desc]
+
+watch:
+  name: watch
+  in: query
+  description: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+  required: false
+  schema:
+    type: boolean

specs/ingestion/common/schemas/task.yml

@@ -606,3 +606,24 @@ Policies:
       type: integer
       minimum: 1
       maximum: 10
+
+PushTaskPayload:
+  title: pushTaskPayload
+  type: object
+  properties:
+    action:
+      $ref: '../../../../common/schemas/Batch.yml#/action'
+    records:
+      type: array
+      items:
+        title: pushTaskRecords
+        type: object
+        additionalProperties: true
+        required:
+          - objectID
+        properties:
+          objectID:
+            $ref: '../../../../common/parameters.yml#/objectID'
+  required:
+    - action
+    - records

specs/ingestion/paths/push.yml

@@ -0,0 +1,31 @@
+post:
+  summary: Push a `batch` request payload through the Pipeline
+  description: Push a `batch` request payload through the Pipeline. You can check the status of your request with the observability endpoints.
+  operationId: push
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
+  x-timeouts:
+    connect: 180000
+    read: 180000
+    write: 180000
+  parameters:
+    - $ref: '../../common/parameters.yml#/IndexName'
+    - $ref: '../common/parameters.yml#/watch'
+  requestBody:
+    description: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
+    content:
+      application/json:
+        schema:
+          $ref: '../common/schemas/task.yml#/PushTaskPayload'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../../common/schemas/common.yml#/WatchResponse'
+    '400':
+      $ref: '../../../../common/responses/BadRequest.yml'

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

@@ -14,36 +14,13 @@ post:
     write: 180000
   parameters:
     - $ref: '../../../common/parameters.yml#/pathTaskID'
-    - name: watch
-      in: query
-      description: When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
-      required: false
-      schema:
-        type: boolean
+    - $ref: '../../../common/parameters.yml#/watch'
   requestBody:
     description: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
     content:
       application/json:
         schema:
-          title: pushTaskPayload
-          type: object
-          properties:
-            action:
-              $ref: '../../../../common/schemas/Batch.yml#/action'
-            records:
-              type: array
-              items:
-                title: pushTaskRecords
-                type: object
-                additionalProperties: true
-                required:
-                  - objectID
-                properties:
-                  objectID:
-                    $ref: '../../../../common/parameters.yml#/objectID'
-          required:
-            - action
-            - records
+          $ref: '../../../common/schemas/task.yml#/PushTaskPayload'
     required: true
   responses:
     '200':

specs/ingestion/spec.yml

@@ -112,6 +112,9 @@ paths:
   /{path}:
     $ref: '../common/paths/customRequest.yml'
 
+  /1/push/{indexName}:
+    $ref: 'paths/push.yml'
+
   # authentications API.
   /1/authentications:
     $ref: 'paths/authentications/authentications.yml'