Api v2 update global task

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

@@ -75,6 +75,7 @@ info:
     * Added GET /api/v2/{objects}/{object_identifier}/comments/{identifier}
     * Added PUT /api/v2/{objects}/{object_identifier}/comments/{identifier}
     * Added DELETE /api/v2/{objects}/{object_identifier}/comments/{identifier}
+    * Added GET /api/v2/manage/customers
     * Added POST /api/v2/manage/customers
     * Added GET /api/v2/manage/customers/{identifier}
     * Added PUT /api/v2/manage/customers/{identifier}
@@ -83,6 +84,10 @@ info:
     * Added GET /api/v2/alerts-filters/{identifier}
     * Added PUT /api/v2/alerts-filters/{identifier}
     * Added DELETE /api/v2/alerts-filters/{identifier}
+    * Added POST /api/v2/global-tasks
+    * Added GET /api/v2/global-tasks/{identifier}
+    * Added PUT /api/v2/global-tasks/{identifier}
+    * Added DELETE /api/v2/global-tasks/{identifier}
     * Deprecated POST /manage/cases/add in favor of POST /api/v2/cases
     * Deprecated POST /manage/cases/update in favor of PUT /api/v2/cases/{case_identifier}
     * Deprecated POST /manage/cases/delete/{case_id} in favor of DELETE /api/v2/cases/{case_identifier}
@@ -131,10 +136,14 @@ info:
     * Deprecated POST /case/{object_name}/{object_id}/comments/add
     * Deprecated POST /case/{object_name}/{object_id}/comments/{comment_id}/edit
     * Deprecated POST /case/{object_name}/{object_id}/comments/{comment_id}/delete
+    * Deprecated GET /manage/customers/list
     * Deprecated POST /manage/customers/add
     * Deprecated GET /manage/customers/{customer_id}
     * Deprecated POST /manage/customers/update/{customer_id}
     * Deprecated POST /manage/customers/delete/{customer_id}
+    * Deprecated POST /global/tasks/add
+    * Deprecated POST /global/tasks/update/{task_id}
+    * Deprecated POST /global/tasks/delete/{task_id}
     * Added documentation of missing GET /manage/severities/list
     * Added documentation of missing GET /manage/tlp/list
     * Added documentation of missing GET /manage/event-categories/list
@@ -228,6 +237,10 @@ paths:
     $ref: v2.1.0/resources/api_v2_assets_{identifier}.yaml
   /api/v2/me:
     $ref: v2.1.0/resources/api_v2_me.yaml
+  /api/v2/global-tasks:
+    $ref: v2.1.0/resources/api_v2_global-tasks.yaml
+  /api/v2/global-tasks/{identifier}:
+    $ref: v2.1.0/resources/api_v2_global-tasks_{identifier}.yaml
   /manage/cases/update/{case_id}:
     $ref: v2.1.0/resources/manage_cases_update_{case_id}.yaml
   /case/summary/update:
@@ -545,6 +558,8 @@ tags:
     description: Endpoints to interact with tasks
   - name: Evidences
     description: Endpoints to interact with evidences
+  - name: Global tasks
+    description: Endpoints to interact with global tasks
   - name: Alerts
     description: Endpoints to interact with alerts
   - name: Customers

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

@@ -0,0 +1,24 @@
+post:
+  operationId: api_v2_global-tasks_post
+  summary: Add a global task
+  description: Add a global task and assign it to a user.
+  tags:
+    - Global tasks
+    - Beta
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../schemas/requestBodies/GlobalTask.yaml
+  responses:
+    '201':
+      description: Global task successfully created
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/GlobalTask.yaml
+    '400':
+      $ref: ../responses/GenericError.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
+

docs/api_reference/reference/v2.1.0/resources/api_v2_global-tasks_{identifier}.yaml

@@ -0,0 +1,58 @@
+parameters:
+  - $ref: ../parameters/path/identifier.yaml
+get:
+  operationId: api_v2_global-tasks_(identifier)_get
+  tags:
+    - Global tasks
+    - Beta
+  summary: Get a global task
+  description: Get a global task
+  responses:
+    '200':
+      description: global task successfully found
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/GlobalTask.yaml
+    '404':
+      $ref: ../responses/NotFound.yaml
+put:
+  operationId: api_v2_global-tasks_(identifier)_put
+  summary: Update a global task
+  description: ''
+  tags:
+    - Global tasks
+    - Beta
+  requestBody:
+    content:
+      application/json:
+        schema:
+            $ref: ../schemas/requestBodies/GlobalTask.yaml
+  responses:
+    '201':
+      description: Global task successfully updated
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/GlobalTask.yaml
+    '400':
+      $ref: ../responses/GenericError.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
+    '404':
+      $ref: ../responses/NotFound.yaml
+delete:
+  operationId: api_v2_global-tasks_(identifier)_delete
+  tags:
+    - Global tasks
+    - Beta
+  summary: Delete a global task
+  description: ''
+  responses:
+    '204':
+      $ref: ../responses/Deleted.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
+    '404':
+      $ref: ../responses/NotFound.yaml
+

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

@@ -21,3 +21,20 @@ 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/api_v2_manage_groups_{identifier}.yaml

@@ -8,7 +8,7 @@ get:
   summary: Get a group
   description: Requires administrative rights.
   responses:
-    '201':
+    '200':
       description: group successfully found
       content:
         application/json:

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

@@ -1,5 +1,7 @@
 post:
   summary: Add a global task
+  description: This endpoint is deprecated. Use [POST /api/v2/global-tasks](#tag/Global-tasks/operation/api_v2_global-tasks_post) instead.
+  deprecated: true
   operationId: post-global-tasks-add
   responses:
     '200':
@@ -135,7 +137,6 @@ post:
                     - Invalid user id for assignee
                 message: Data error
                 status: error
-  description: 'Add a global task and assign it to a user. '
   security:
     - Bearer <bearer>: []
   requestBody:

docs/api_reference/reference/v2.1.0/resources/global_tasks_delete_{task_id}.yaml

@@ -1,5 +1,7 @@
 get:
   summary: Delete a global task
+  description: This endpoint is deprecated. Use [DELETE /api/v2/global-tasks/{identifier}](#tag/Global-tasks/operation/api_v2_global-tasks_(identifier)_delete) instead.
+  deprecated: true
   tags:
     - Global tasks
   responses:
@@ -69,7 +71,6 @@ get:
                 message: Invalid global task ID
                 status: error
   operationId: get-global-tasks-delete
-  description: ''
   security:
     - Bearer <bearer>: []
 parameters:

docs/api_reference/reference/v2.1.0/resources/global_tasks_update_{task_id}.yaml

@@ -7,6 +7,8 @@ parameters:
     description: Global task ID to update
 post:
   summary: Update a global task
+  description: This endpoint is deprecated. Use [PUT /api/v2/global-tasks/{identifier}](#tag/Global-tasks/operation/api_v2_global-tasks_(identifier)_put) instead.
+  deprecated: true
   operationId: post-global-tasks-update-task_id
   responses:
     '200':
@@ -128,7 +130,6 @@ post:
                 status: error
   tags:
     - Global tasks
-  description: ''
   requestBody:
     content:
       application/json:

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

@@ -1,5 +1,7 @@
 get:
   summary: List customers
+  description: This endpoint is deprecated. Use [GET /api/v2/manage/customers](#tag/Customers/operation/api_v2_manage_customers_get) instead.
+  deprecated: true
   tags:
     - Customers
   responses:
@@ -65,7 +67,6 @@ get:
                 message: ''
                 status: success
   operationId: get-manage-customers-list
-  description: List customers
   parameters:
     - schema:
         type: integer

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

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

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

@@ -0,0 +1,51 @@
+type: object
+properties:
+  task_id:
+    type: number
+  task_title:
+    type: string
+    minLength: 1
+  task_description:
+    type:
+      - string
+      - 'null'
+  task_status_id:
+    type: number
+  task_assignee_id:
+    type: number
+  task_tags:
+    type:
+      - string
+      - 'null'
+  task_userid_open:
+    type: integer
+  task_open_date:
+    type: string
+    minLength: 1
+  task_userid_update:
+    type: number
+  task_last_update:
+    type: string
+    minLength: 1
+  task_userid_close:
+    type:
+      - integer
+      - 'null'
+  task_close_date:
+    anyOf:
+      - $ref: ../schemas/iso_date.yaml
+      - type: 'null'
+example:
+  task_id: 9
+  task_title: Task title
+  task_description: My task description
+  task_status_id: 15
+  task_assignee_id: 1
+  task_tags: ''
+  task_userid_open: null
+  task_open_date: '2022-01-21T17:07:10.005183'
+  task_userid_update: 1
+  task_last_update: '2022-01-21T17:07:10.005200'
+  task_userid_close: null
+  task_close_date: null
+

docs/api_reference/reference/v2.1.0/schemas/requestBodies/GlobalTask.yaml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  task_title:
+    type: string
+    minLength: 2
+  task_description:
+    type: string
+  task_status_id:
+    description: The initial status of the task
+    type: integer
+  task_assignee_id:
+    type: integer
+    description: A user ID for whom the task will be assigned
+  task_tags:
+    type: string
+  task_open_date:
+    $ref: ../../schemas/iso_date.yaml
+  task_userid_open:
+    type: integer
+  task_last_update:
+    $ref: ../../schemas/iso_date.yaml
+  task_userid_update:
+    type: integer
+  task_close_date:
+    $ref: ../../schemas/iso_date.yaml
+  task_userid_close:
+    type: integer
+required:
+  - task_title
+  - task_status_id
+  - task_assignee_id
+example:
+  task_title: Task title
+  task_description: My task description
+  task_status_id: 14
+  task_assignee_id: 1
+  task_tags: ''
+