Merge pull request #100 from dfir-iris/api_v2_paginated_global_tasks

Api v2 paginated global tasks

Author: whikernel

docs/api_reference/reference/iris.v2.1.0.yaml

@@ -84,6 +84,7 @@ info:
     * Added GET /api/v2/alerts-filters/{identifier}
     * Added PUT /api/v2/alerts-filters/{identifier}
     * Added DELETE /api/v2/alerts-filters/{identifier}
+    * Added GET /api/v2/global-tasks
     * Added POST /api/v2/global-tasks
     * Added GET /api/v2/global-tasks/{identifier}
     * Added PUT /api/v2/global-tasks/{identifier}
@@ -142,6 +143,7 @@ info:
     * Deprecated POST /manage/customers/update/{customer_id}
     * Deprecated POST /manage/customers/delete/{customer_id}
     * Deprecated POST /global/tasks/add
+    * Deprecated GET /global/tasks/list
     * Deprecated POST /global/tasks/update/{task_id}
     * Deprecated POST /global/tasks/delete/{task_id}
     * Added documentation of missing GET /manage/severities/list

docs/api_reference/reference/v2.1.0/resources/api_v2_global-tasks.yaml

@@ -1,3 +1,19 @@
+get:
+  operationId: api_v2_global-tasks_get
+  summary: List global tasks
+  description: Returns a list of all global tasks
+  tags:
+    - Global tasks
+    - Beta
+  responses:
+    '200':
+      description: Paginated list of global tasks
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/GlobalTasks.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
 post:
   operationId: api_v2_global-tasks_post
   summary: Add a global task

docs/api_reference/reference/v2.1.0/resources/api_v2_manage_customers.yaml

@@ -1,3 +1,19 @@
+get:
+  operationId: api_v2_manage_customers_get
+  summary: List customers
+  description: List customers
+  tags:
+    - Customers
+    - Beta
+  responses:
+    '200':
+      description: Paginated list of customers
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/Customers.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
 post:
   operationId: api_v2_manage_customers_post
   summary: Add a customer
@@ -21,20 +37,3 @@ post:
       $ref: ../responses/GenericError.yaml
     '403':
       $ref: ../responses/Forbidden.yaml
-get:
-  operationId: api_v2_manage_customers_get
-  summary: List customers
-  description: List customers
-  tags:
-    - Customers
-    - Beta
-  responses:
-    '200':
-      description: Paginated list of customers
-      content:
-        application/json:
-          schema:
-            $ref: ../schemas/Customers.yaml
-    '403':
-      $ref: ../responses/Forbidden.yaml
-

docs/api_reference/reference/v2.1.0/resources/global_tasks_list.yaml

@@ -1,5 +1,7 @@
 get:
   summary: List global tasks
+  description: This endpoint is deprecated. Use [GET /api/v2/global-tasks](#tag/Global-tasks/operation/api_v2_global-tasks_get) instead.
+  deprecated: true
   tags:
     - Global tasks
   responses:
@@ -231,4 +233,3 @@ get:
   operationId: get-global-tasks-list
   security:
     - Bearer <bearer>: []
-  description: Returns a list of all global tasks

docs/api_reference/reference/v2.1.0/schemas/GlobalTasks.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  total:
+    type: integer
+  data:
+    type: array
+    items:
+      $ref: ../schemas/GlobalTask.yaml
+  last_page:
+    type: integer
+  current_page:
+    type: integer
+  next_page:
+    type:
+      - integer
+      - 'null'