Skip to content

Commit 4b1f1fd

Browse files
authored
feat(specs): add query params to task lists endpoint in Ingestion APIC (#1233)
1 parent 310d261 commit 4b1f1fd

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
enabled:
2+
name: enabled
3+
in: query
4+
description: If the returned task should have its 'enabled' property set to true.
5+
required: false
6+
schema:
7+
type: boolean
8+
9+
action:
10+
name: action
11+
in: query
12+
description: Which action the returned task should have. Can be a list of string separated with commas.
13+
required: false
14+
style: form
15+
explode: false
16+
schema:
17+
type: array
18+
items:
19+
$ref: './schemas/task.yml#/ActionType'
20+
example: save,replace
21+
22+
destinationID:
23+
name: destinationID
24+
in: query
25+
description: Which destinationID the returned task should have. Can be a list of string separated with commas.
26+
required: false
27+
style: form
28+
explode: false
29+
schema:
30+
type: array
31+
items:
32+
type: string
33+
34+
triggerType:
35+
name: triggerType
36+
in: query
37+
description: Which trigger type the returned task should have. Can be a list of string separated with commas.
38+
required: false
39+
style: form
40+
explode: false
41+
schema:
42+
type: array
43+
items:
44+
$ref: './schemas/task.yml#/TriggerType'
45+
example: on_demand,schedule

specs/ingestion/paths/tasks/tasks.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ get:
77
parameters:
88
- $ref: '../../common/parameters.yml#/itemsPerPage'
99
- $ref: '../../common/parameters.yml#/page'
10+
- $ref: '../../common/taskParameters.yml#/action'
11+
- $ref: '../../common/taskParameters.yml#/enabled'
12+
- $ref: '../../common/taskParameters.yml#/destinationID'
13+
- $ref: '../../common/taskParameters.yml#/triggerType'
1014
responses:
1115
'200':
1216
description: OK

0 commit comments

Comments
 (0)