diff --git a/data/deprecations/17-8-deprecation-workspaces-editor-graphql-field.yml b/data/deprecations/17-8-deprecation-workspaces-editor-graphql-field.yml new file mode 100644 index 0000000000000000000000000000000000000000..e15466c7397609a871996857249bf706dbef8364 --- /dev/null +++ b/data/deprecations/17-8-deprecation-workspaces-editor-graphql-field.yml @@ -0,0 +1,45 @@ +- title: "Workspaces `editor` GraphQL field is deprecated" + # The milestones for the deprecation announcement, and the removal. + removal_milestone: "18.0" + announcement_milestone: "17.8" + # Change breaking_change to false if needed. + breaking_change: true + reporter: saahmed + stage: create + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/508155 + # Use the impact calculator https://gitlab-com.gitlab.io/gl-infra/breaking-change-impact-calculator/? + impact: low + scope: project + window: 1 + resolution_role: # Can be one of: [Admin, Owner, Maintainer, Developer] + manual_task: true + body: | # (required) Don't change this line. + The `editor` field is not used internally. It will be deprecated in the following GraphQL elements: + + - `Workspace` type. + - Input to `workspaceCreate` mutation. + + To prepare for this change: + + - Review and update your GraphQL queries that interact with the `Workspace` type. + - Remove any references to the `editor` field. + - Adjust your application logic accordingly. + + # ============================== + # OPTIONAL END-OF-SUPPORT FIELDS + # ============================== + # + # If an End of Support period applies: + # 1) Share this announcement in the `#spt_managers` Support channel in Slack + # 2) Mention `@gitlab-com/support` in this merge request. + # + # When support for this feature ends, in XX.YY milestone format. + end_of_support_milestone: + # Array of tiers the feature is currently available to, + # like [Free, Silver, Gold, Core, Premium, Ultimate] + tiers: + # Links to documentation and thumbnail image + documentation_url: + image_url: + # Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg + video_url: diff --git a/doc/update/breaking_windows.md b/doc/update/breaking_windows.md index 8d271073ffb0cc4e9db74dd2a44227b2edfc4190..d06a0c645e9738dbb5acdc77cd5b5566ea0ebecf 100644 --- a/doc/update/breaking_windows.md +++ b/doc/update/breaking_windows.md @@ -42,6 +42,7 @@ This window takes place on April 21 - 23, 2025 from 09:00 UTC to 22:00 UTC. | [Deprecation of `name` field in `ProjectMonthlyUsageType` GraphQL API](https://gitlab.com/gitlab-org/gitlab/-/issues/381894) | Low | Fulfillment | Project | | [Rename 'setPreReceiveSecretDetection' GraphQL mutation to 'setSecretPushProtection'](https://gitlab.com/gitlab-org/gitlab/-/issues/462504) | Low | Application_security_testing | Project | | [Deprecation of `STORAGE` enum in `NamespaceProjectSortEnum` GraphQL API](https://gitlab.com/gitlab-org/gitlab/-/issues/396284) | Low | Fulfillment | Group | +| [Workspaces `editor` GraphQL field is deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/508155) | Low | Create | Project | ## Window 2 diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 2de0c864ddaa7b21dba0b3cb51e5eda24d73b615..ed64caf3f821e80c52c14847c92890962ca35115 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -1197,6 +1197,31 @@ Toggling notes confidentiality with REST and GraphQL APIs is being deprecated. U