summaryrefslogtreecommitdiff
path: root/data/deprecations/14-5-runner-api-status-does-contain-paused.yml
blob: 0daa5fb24c9153526f7092df37245a144edde316 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
- title: "GraphQL API Runner status will not return `paused`"
  announcement_milestone: "14.5"  # The milestone when this feature was first announced as deprecated.
  removal_milestone: "16.0"  # the milestone 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 GraphQL API endpoints will not return `paused` or `active` as a status in GitLab 16.0.
    In a future v5 of the REST API, the endpoints for GitLab Runner will also not return `paused` or `active`.

    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
    `paused` to be `true` instead. When checking if a runner is `active`, check if `paused` is `false`.
  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