Skip to content

feat(API): add updated_since filter to job list #STRINGS-1555 #799

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.

Sign up for GitHub

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

Merged
jablan merged 2 commits into from
Feb 21, 2025
Merged

feat(API): add updated_since filter to job list #STRINGS-1555 #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c38be85
feat(API): add updated_since filter to job list #STRINGS-1555
jablan Feb 21, 2025
bb49768
typo
jablan Feb 21, 2025
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
98 changes: 49 additions & 49 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4716,6 +4716,42 @@
"schema": {
"type": "string"
}
},
"job_owner": {
"description": "filter by user owning job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "owned_by",
"in": "query",
"schema": {
"type": "string"
}
},
"job_assignee": {
"description": "filter by user assigned to job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "assigned_to",
"in": "query",
"schema": {
"type": "string"
}
},
"job_state": {
"description": "filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>",
"example": "completed",
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
},
"job_updated_since": {
"description": "filter by jobs updated since given date",
"example": "2013-02-21T00:00:00.000Z",
"name": "updated_since",
"in": "query",
"schema": {
"type": "string"
}
}
},
"responses": {
Expand Down Expand Up @@ -10309,40 +10345,19 @@
"$ref": "#/components/parameters/per_page"
},
{
"description": "specify the branch to use",
"example": "my-feature-branch",
"name": "branch",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/branch"
},
{
"description": "filter by user owning job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "owned_by",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_owner"
},
{
"description": "filter by user assigned to job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "assigned_to",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_assignee"
},
{
"description": "filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>",
"example": "completed",
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_state"
},
{
"$ref": "#/components/parameters/job_updated_since"
}
],
"responses": {
Expand Down Expand Up @@ -10553,31 +10568,16 @@
"$ref": "#/components/parameters/per_page"
},
{
"description": "filter by user owning job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "owned_by",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_owner"
},
{
"description": "filter by user assigned to job",
"example": "abcd1234cdef1234abcd1234cdef1234",
"name": "assigned_to",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_assignee"
},
{
"description": "filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>",
"example": "completed",
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/job_state"
},
{
"$ref": "#/components/parameters/job_updated_since"
}
],
"responses": {
Expand Down
29 changes: 28 additions & 1 deletion parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,4 +260,31 @@ q:
in: query
schema:
type: string

job_owner:
description: filter by user owning job
example: abcd1234cdef1234abcd1234cdef1234
name: owned_by
in: query
schema:
type: string
job_assignee:
description: filter by user assigned to job
example: abcd1234cdef1234abcd1234cdef1234
name: assigned_to
in: query
schema:
type: string
job_state:
description: "filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>"
example: completed
name: state
in: query
schema:
type: string
job_updated_since:
description: filter by jobs updated since given date
example: 2013-02-21T00:00:00Z
name: updated_since
in: query
schema:
type: string
29 changes: 5 additions & 24 deletions paths/jobs/index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,11 @@ parameters:
- "$ref": "../../parameters.yaml#/project_id"
- "$ref": "../../parameters.yaml#/page"
- "$ref": "../../parameters.yaml#/per_page"
- description: specify the branch to use
example: my-feature-branch
name: branch
in: query
schema:
type: string
- description: filter by user owning job
example: abcd1234cdef1234abcd1234cdef1234
name: owned_by
in: query
schema:
type: string
- description: filter by user assigned to job
example: abcd1234cdef1234abcd1234cdef1234
name: assigned_to
in: query
schema:
type: string
- description: filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
example: completed
name: state
in: query
schema:
type: string
- "$ref": "../../parameters.yaml#/branch"
- "$ref": "../../parameters.yaml#/job_owner"
- "$ref": "../../parameters.yaml#/job_assignee"
- "$ref": "../../parameters.yaml#/job_state"
- "$ref": "../../parameters.yaml#/job_updated_since"
responses:
'200':
description: OK
Expand Down
22 changes: 4 additions & 18 deletions paths/jobs/index_account.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,10 @@ parameters:
- "$ref": "../../parameters.yaml#/account_id"
- "$ref": "../../parameters.yaml#/page"
- "$ref": "../../parameters.yaml#/per_page"
- description: filter by user owning job
example: abcd1234cdef1234abcd1234cdef1234
name: owned_by
in: query
schema:
type: string
- description: filter by user assigned to job
example: abcd1234cdef1234abcd1234cdef1234
name: assigned_to
in: query
schema:
type: string
- description: filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
example: completed
name: state
in: query
schema:
type: string
- "$ref": "../../parameters.yaml#/job_owner"
- "$ref": "../../parameters.yaml#/job_assignee"
- "$ref": "../../parameters.yaml#/job_state"
- "$ref": "../../parameters.yaml#/job_updated_since"
responses:
'200':
description: OK
Expand Down