feat(specs): add getAppTask endpoint to search (#3156)

algolia · Jun 11, 2024 · fd5a312 · fd5a312 · github-actions · Jun 11, 2024
1 parent 5f7a974
commit fd5a312
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 0 deletions.
diff --git a/specs/search/paths/advanced/getAppTask.yml b/specs/search/paths/advanced/getAppTask.yml
@@ -0,0 +1,38 @@
+get:
+  tags:
+    - Advanced
+  operationId: getAppTask
+  x-acl:
+    - editSettings
+  description: |
+    Checks the status of a given application task.
+  summary: Check application task status
+  parameters:
+    - name: taskID
+      in: path
+      description: Unique task identifier.
+      required: true
+      schema:
+        type: integer
+        format: int64
+        example: 1506303845001
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: getTaskResponse
+            type: object
+            additionalProperties: false
+            properties:
+              status:
+                $ref: '../../common/enums.yml#/taskStatus'
+            required:
+              - status
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'
+    '402':
+      $ref: '../../../common/responses/FeatureNotEnabled.yml'
+    '403':
+      $ref: '../../../common/responses/MethodNotAllowed.yml'
diff --git a/specs/search/spec.yml b/specs/search/spec.yml
@@ -339,6 +339,8 @@ paths:
   # ##########################
   /1/logs:
     $ref: 'paths/advanced/getLogs.yml'
+  /1/task/{taskID}:
+    $ref: 'paths/advanced/getAppTask.yml'
   /1/indexes/{indexName}/task/{taskID}:
     $ref: 'paths/advanced/getTask.yml'
 

diff --git a/tests/CTS/requests/search/getAppTask.json b/tests/CTS/requests/search/getAppTask.json
@@ -0,0 +1,11 @@
+[
+  {
+    "parameters": {
+      "taskID": 123
+    },
+    "request": {
+      "path": "/1/task/123",
+      "method": "GET"
+    }
+  }
+]