Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(specs): add query params to task lists endpoint in Ingestion APIC #1233

Merged
merged 3 commits into from
Jan 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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