32 lines
1.6 KiB
YAML
32 lines
1.6 KiB
YAML
- title: "REST and GraphQL API Runner usage of `active` replaced by `paused`"
|
|
announcement_milestone: "14.8"
|
|
announcement_date: "2022-02-22"
|
|
removal_milestone: "16.0"
|
|
removal_date: "2023-05-22"
|
|
breaking_change: true
|
|
reporter: pedropombeiro
|
|
body: |
|
|
Occurrences of the `active` identifier in the GitLab Runner GraphQL API endpoints will be
|
|
renamed to `paused` in GitLab 16.0.
|
|
|
|
- For the GraphQL API, this change affects:
|
|
- the `CiRunner` property
|
|
- the `RunnerUpdateInput` input type for the `runnerUpdate` mutation
|
|
- the `runners` and `Group.runners` queries
|
|
- In v4 of the REST API, starting in GitLab 14.8, you can use the `paused` property in place of `active`
|
|
- In v5 of the REST API, this change will affect:
|
|
- endpoints taking or returning `active` property, such as:
|
|
- `GET /runners`
|
|
- `GET /runners/all`
|
|
- `GET /runners/:id` / `PUT /runners/:id`
|
|
- `PUT --form "active=false" /runners/:runner_id`
|
|
- `GET /projects/:id/runners` / `POST /projects/:id/runners`
|
|
- `GET /groups/:id/runners`
|
|
|
|
The 16.0 release of GitLab Runner will start using the `paused` property when registering runners.
|
|
stage: Verify
|
|
tiers: [Core, Premium, Ultimate]
|
|
issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351109
|
|
documentation_url: https://docs.gitlab.com/ee/api/graphql/reference/#cirunner
|
|
image_url: # (optional) This is a link to a thumbnail image depicting the feature
|
|
video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
|