Skip to content

Commit 44dacf3

Browse files
committed
Documentation of GET /api/v2/global-tasks/{identifier}
1 parent f63dcaa commit 44dacf3

3 files changed

Lines changed: 24 additions & 1 deletion

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ info:
8585
* Added PUT /api/v2/alerts-filters/{identifier}
8686
* Added DELETE /api/v2/alerts-filters/{identifier}
8787
* Added POST /api/v2/global-tasks
88+
* Added GET /api/v2/global-tasks/{identifier}
8889
* Deprecated POST /manage/cases/add in favor of POST /api/v2/cases
8990
* Deprecated POST /manage/cases/update in favor of PUT /api/v2/cases/{case_identifier}
9091
* Deprecated POST /manage/cases/delete/{case_id} in favor of DELETE /api/v2/cases/{case_identifier}
@@ -234,6 +235,8 @@ paths:
234235
$ref: v2.1.0/resources/api_v2_me.yaml
235236
/api/v2/global-tasks:
236237
$ref: v2.1.0/resources/api_v2_global-tasks.yaml
238+
/api/v2/global-tasks/{identifier}:
239+
$ref: v2.1.0/resources/api_v2_global-tasks_{identifier}.yaml
237240
/manage/cases/update/{case_id}:
238241
$ref: v2.1.0/resources/manage_cases_update_{case_id}.yaml
239242
/case/summary/update:
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
parameters:
2+
- $ref: ../parameters/path/identifier.yaml
3+
get:
4+
operationId: api_v2_global-tasks_(identifier)_get
5+
tags:
6+
- Global tasks
7+
- Beta
8+
summary: Get a global task
9+
description: Get a global task
10+
responses:
11+
'200':
12+
description: global task successfully found
13+
content:
14+
application/json:
15+
schema:
16+
$ref: ../schemas/GlobalTask.yaml
17+
'404':
18+
$ref: ../responses/NotFound.yaml
19+
20+

docs/api_reference/reference/v2.1.0/resources/api_v2_manage_groups_{identifier}.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ get:
88
summary: Get a group
99
description: Requires administrative rights.
1010
responses:
11-
'201':
11+
'200':
1212
description: group successfully found
1313
content:
1414
application/json:

0 commit comments

Comments
 (0)