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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ListTasks: proposed filters #104

Closed
wants to merge 3 commits into from
Closed
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
33 changes: 26 additions & 7 deletions openapi/task_execution.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,6 @@ paths:
schema:
$ref: '#/definitions/tesListTasksResponse'
parameters:
- name: name_prefix
description: |-
OPTIONAL. Filter the list to include tasks where the name matches this prefix.
If unspecified, no task name filtering is done.
in: query
required: false
type: string
- name: page_size
description: |-
OPTIONAL. Number of tasks to return in one page.
Expand Down Expand Up @@ -67,6 +60,32 @@ paths:
- BASIC
- FULL
default: MINIMAL
- name: state
description: |-
OPTIONAL. Filter tasks by state. If unspecified,
no task state filtering is done.
in: query
required: false
$ref: '#/definitions/tesState'
- name: tags
description: |-
OPTIONAL. Filter tasks by tag. If unspecified,
no task tag filtering is done. Both the tag's
key and value must be exact matches for a task to be returned.
Filter Tags Match?
----------------------------------------------------------------------
{"foo": "bar"} {"foo": "bar"} Yes
{"foo": ""} {"foo": ""} Yes
{"foo": "bar", "baz": "bat"} {"foo": "bar", "baz": "bat"} Yes
{"foo": "bar"} {"foo": "bar", "baz": "bat"} Yes
{"foo": "bar", "baz": "bat"} {"foo": "bar"} No
{"foo": ""} {"foo": "bar"} No
in: body
required: false
type: object
additionalProperties:
type: string

tags:
- TaskService
post:
Expand Down