diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-30 18:08:31 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-30 18:08:31 +0000 |
commit | 7510df057e6230ce3d6f20772b0460ca2eb4bd63 (patch) | |
tree | 68a726ba9b534a51ec92a78be952fce286aead31 /data/deprecations | |
parent | 4dd542c93535f21d0fde62080be2dd98e3926fb1 (diff) | |
download | gitlab-ce-7510df057e6230ce3d6f20772b0460ca2eb4bd63.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'data/deprecations')
4 files changed, 20 insertions, 32 deletions
diff --git a/data/deprecations/14-5-runner-api-status-does-contain-paused.yml b/data/deprecations/14-5-runner-api-status-does-contain-paused.yml index 5acfac45ca2..41124638509 100644 --- a/data/deprecations/14-5-runner-api-status-does-contain-paused.yml +++ b/data/deprecations/14-5-runner-api-status-does-contain-paused.yml @@ -1,11 +1,12 @@ -- name: "REST and GraphQL API Runner status will not return `paused`" +- name: "GraphQL API Runner status will not return `paused`" announcement_milestone: "14.5" # The milestone when this feature was first announced as deprecated. announcement_date: "2021-11-22" removal_milestone: "16.0" # the milestone when this feature is planned to be removed removal_date: "2023-04-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 16.0. + 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. 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 diff --git a/data/deprecations/14-8-runner-api-project_type-breaking-change.yml b/data/deprecations/14-8-runner-api-project_type-breaking-change.yml deleted file mode 100644 index d965d830c58..00000000000 --- a/data/deprecations/14-8-runner-api-project_type-breaking-change.yml +++ /dev/null @@ -1,15 +0,0 @@ -- name: "REST API endpoint to list group runners no longer accepts `project_type` value for `type` argument" - announcement_milestone: "14.8" - announcement_date: "2022-02-22" - removal_milestone: "16.0" - removal_date: "2023-04-22" - breaking_change: true - reporter: pedropombeiro - body: | - The `GET /groups/:id/runners?type=project_type` endpoint will be removed in GitLab 16.0. The endpoint always returned an empty collection. - stage: Verify - tiers: [Core, Premium, Ultimate] - issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351466 - documentation_url: https://docs.gitlab.com/ee/api/runners.html - 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 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 index 174e51f5f5d..376a27c8863 100644 --- 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 @@ -1,17 +1,20 @@ -- name: "REST API Runner will not accept `status` filter values of `active` or `paused`" +- name: "GraphQL 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. + The GitLab Runner GraphQL 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`. + 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`. + + The REST API endpoints will follow in the same direction in a future REST v5 API, however the new `paused` + status value can be used in place of `active` since GitLab 14.8. stage: Verify tiers: [Core, Premium, Ultimate] issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/351109 |