diff options
Diffstat (limited to 'data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml')
| -rw-r--r-- | data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml b/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml new file mode 100644 index 00000000000..51472b3cd28 --- /dev/null +++ b/data/deprecations/14-8-runner-api-status-filter-does-accept-active-or-paused.yml @@ -0,0 +1,18 @@ +- name: "REST API Runner will not accept `status` filter values of `active` or `paused`" + announcement_milestone: "14.8" # The milestone when this feature was first announced as deprecated. + announcement_date: "2022-02-22" + removal_milestone: "16.0" + removal_date: "2023-04-22" + breaking_change: true + body: | # Do not modify this line, instead modify the lines below. + The GitLab Runner REST endpoints will stop accepting `paused` or `active` as a status value in GitLab 16.0. + + A runner's status will only relate to runner contact status, such as: `online`, `offline`. + Status values `paused` or `active` will no longer be accepted and will be replaced by the `paused` query parameter. + + When checking for paused runners, API users are advised to specify `paused=true` as the query parameter. + When checking for active runners, specify `paused=false`. + stage: Verify + tiers: [Core, Premium, Ultimate] + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351109 + documentation_url: https://docs.gitlab.com/ee/api/runners.html |