diff options
Diffstat (limited to 'data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml')
| -rw-r--r-- | data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml b/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml index 99af852c13e..223c1439191 100644 --- a/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml +++ b/data/deprecations/14-8-runner-api-active-field-replaced-with-paused-breaking-change.yml @@ -6,15 +6,16 @@ breaking_change: true reporter: pedropombeiro body: | - Occurrences of the `active` identifier in the GitLab Runner REST and GraphQL API endpoints will be - renamed to `paused` in GitLab 16.0, namely: + Occurrences of the `active` identifier in the GitLab Runner GraphQL API endpoints will be + renamed to `paused` in GitLab 16.0. - - GraphQL API: - - the `CiRunner` property; - - the `RunnerUpdateInput` input type for the `runnerUpdate` mutation; - - the `runners` and `Group.runners` queries. - - REST API: - - endpoints taking or returning `active` properties, such as: + - 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` @@ -22,9 +23,7 @@ - `GET /projects/:id/runners` / `POST /projects/:id/runners` - `GET /groups/:id/runners` - The 16.0 release of the GitLab Runner will start using the `paused` property when registering runners, and therefore - will only be compatible with GitLab 16.0 and later. Until 16.0, GitLab will accept the deprecated `active` flag from - existing 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 |