summaryrefslogtreecommitdiff
path: root/data/deprecations/14-5-runner-api-status-does-contain-paused.yml
blob: dd2e6e7a6fb5ee9a9d338c6e5b2de3a464155269 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- name: "REST API Runner will not contain `paused`"
  announcement_milestone: "14.5" # The milestone when this feature was first announced as deprecated.
  announcement_date: "2021-11-22"
  removal_milestone: "15.0" # the milestone when this feature is planned to be removed
  removal_date: "2022-05-22" # the date of the milestone release when this feature is planned to be removed
  breaking_change: true
  body: | # Do not modify this line, instead modify the lines below.
    The GitLab Runner REST and GraphQL API endpoints will not return `paused` or `active` as a status in GitLab 15.0.

    A runner's status will only relate to runner contact status, such as:
    `online`, `offline`, or `not_connected`. Status `paused` or `active` will no longer appear.

    When checking if a runner is `paused`, API users are advised to check the boolean attribute
    `active` to be `false` instead. When checking if a runner is `active`, check if `active` is `true`.
  stage: Verify
  tiers: [Core, Premium, Ultimate]
  issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/344648
  documentation_url: https://docs.gitlab.com/ee/api/runners.html