From 3d0802a12d16143b56ce6b44489b87d0d034a16a Mon Sep 17 00:00:00 2001 From: Matt Wilson <mwilson@gitlab.com> Date: Fri, 8 Jul 2022 20:14:23 +0000 Subject: [PATCH] Deprecate use of id for vulnerabilityFindingDismiss mutation --- ...3-vulnerabilityFindingDismiss-mutation.yml | 23 +++++++++++++++++++ doc/update/deprecations.md | 14 +++++++++++ 2 files changed, 37 insertions(+) create mode 100644 data/deprecations/15-3-vulnerabilityFindingDismiss-mutation.yml diff --git a/data/deprecations/15-3-vulnerabilityFindingDismiss-mutation.yml b/data/deprecations/15-3-vulnerabilityFindingDismiss-mutation.yml new file mode 100644 index 0000000000000000..25e8a6a2488b0812 --- /dev/null +++ b/data/deprecations/15-3-vulnerabilityFindingDismiss-mutation.yml @@ -0,0 +1,23 @@ +# +# REQUIRED FIELDS +# +- name: "Use of `id` field in vulnerabilityFindingDismiss mutation" # (required) The name of the feature to be deprecated + announcement_milestone: "15.3" # (required) The milestone when this feature was first announced as deprecated. + announcement_date: "2022-08-22" # (required) The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. + removal_milestone: "16.0" # (required) The milestone when this feature is planned to be removed + removal_date: 2023-05-22 # (required) The date of the milestone release when this feature is planned to be removed. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. + breaking_change: true # (required) If this deprecation is a breaking change, set this value to true + reporter: matt_wilson # (required) GitLab username of the person reporting the deprecation + stage: Secure # (required) String value of the stage that the feature was created in. e.g., Growth + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/367166 # (required) Link to the deprecation issue in GitLab + body: | # (required) Do not modify this line, instead modify the lines below. + You can use the vulnerabilityFindingDismiss GraphQL mutation to set the status of a vulnerability finding to `Dismissed`. Previously, this mutation used the `id` field to identify findings uniquely. However, this did not work for dismissing findings from the pipeline security tab. Therefore, using the `id` field as an identifier has been dropped in favor of the `uuid` field. Using the 'uuid' field as an identifier allows you to dismiss the finding from the pipeline security tab. +# +# OPTIONAL FIELDS +# + end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end. + end_of_support_date: # (optional) The date of the milestone release when support for this feature will end. + tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate] + documentation_url: https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationvulnerabilityfindingdismiss + 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/doc/update/deprecations.md b/doc/update/deprecations.md index b69f8de2947b9b4b..457da6ccbb0ccbed 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -132,6 +132,20 @@ With GitLab 13.9, in the Omnibus GitLab package and GitLab Helm chart 4.9, the R Redis 5 has reached the end of life in April 2022 and will no longer be supported as of GitLab 15.6. If you are using your own Redis 5.0 instance, you should upgrade it to Redis 6.0 or higher before upgrading to GitLab 16.0 or higher. +</div> + +<div class="deprecation removal-160 breaking-change"> + +### Use of `id` field in vulnerabilityFindingDismiss mutation + +Planned removal: GitLab <span class="removal-milestone">16.0</span> (2023-05-22) + +WARNING: +This is a [breaking change](https://docs.gitlab.com/ee/development/deprecation_guidelines/). +Review the details carefully before upgrading. + +You can use the vulnerabilityFindingDismiss GraphQL mutation to set the status of a vulnerability finding to `Dismissed`. Previously, this mutation used the `id` field to identify findings uniquely. However, this did not work for dismissing findings from the pipeline security tab. Therefore, using the `id` field as an identifier has been dropped in favor of the `uuid` field. Using the 'uuid' field as an identifier allows you to dismiss the finding from the pipeline security tab. + </div> </div> -- GitLab