Skip to content

Commit

Permalink
feat(specs): add query params to task lists endpoint in Ingestion APIC (
Browse files Browse the repository at this point in the history
  • Loading branch information
Fluf22 committed Jan 16, 2023
1 parent 310d261 commit 4b1f1fd
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
45 changes: 45 additions & 0 deletions specs/ingestion/common/taskParameters.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
enabled:
name: enabled
in: query
description: If the returned task should have its 'enabled' property set to true.
required: false
schema:
type: boolean

action:
name: action
in: query
description: Which action the returned task should have. Can be a list of string separated with commas.
required: false
style: form
explode: false
schema:
type: array
items:
$ref: './schemas/task.yml#/ActionType'
example: save,replace

destinationID:
name: destinationID
in: query
description: Which destinationID the returned task should have. Can be a list of string separated with commas.
required: false
style: form
explode: false
schema:
type: array
items:
type: string

triggerType:
name: triggerType
in: query
description: Which trigger type the returned task should have. Can be a list of string separated with commas.
required: false
style: form
explode: false
schema:
type: array
items:
$ref: './schemas/task.yml#/TriggerType'
example: on_demand,schedule
4 changes: 4 additions & 0 deletions specs/ingestion/paths/tasks/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ get:
parameters:
- $ref: '../../common/parameters.yml#/itemsPerPage'
- $ref: '../../common/parameters.yml#/page'
- $ref: '../../common/taskParameters.yml#/action'
- $ref: '../../common/taskParameters.yml#/enabled'
- $ref: '../../common/taskParameters.yml#/destinationID'
- $ref: '../../common/taskParameters.yml#/triggerType'
responses:
'200':
description: OK
Expand Down

0 comments on commit 4b1f1fd

Please sign in to comment.