Remove the ability to use a global ID in the work items route
For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features
Deprecation Summary
We want to remove the ability to use Global IDs in the work items route. Currently the route can handle an IID if provided the iid_path=true
query param, as in:
- https://gitlab.com/gitlab-org/gitlab/-/work_items/?iid_path=true
We are deprecating the ability to use a global ID in that route
-
https://gitlab.com/gitlab-org/gitlab/-/work_items/<global_id>
currently works, will no longer work in 16.0. - https://gitlab.com/gitlab-org/gitlab/-/work_items/?iid_path=true currently works, we want to make the default in 16.0 without the need to provide the query param
- https://gitlab.com/gitlab-org/gitlab/-/work_items/ will be the only route that works in 16.0
Breaking Change
Users will no longer be able to use a route like the following:
https://gitlab.com/gitlab-org/gitlab/-/work_items/<global_id>
They will need to use a route with an IID in it:
https://gitlab.com/gitlab-org/gitlab/-/work_items/<iid>
These URLs are generated across the app, and we have changed it everywhere so it generates the IID URL
Affected Topology
Self-managed users and SaaS users
Affected Tier
Which tier is this feature available in?
- Free
Checklists
Labels
-
This issue is labeled deprecation, and with the relevant ~devops::
,~group::
, and~Category:
labels. -
This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.
Timeline
Please add links to the relevant merge requests.
- As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule:
14.8, 14.9, 14.10, 15.0
–14.8
is the third milestone preceding the major release):-
A deprecation announcement entry has been created so the deprecation will appear in release posts and on the general deprecation page. -
Documentation has been updated to mark the feature as deprecated.
-
-
On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post. - On the major milestone:
-
The deprecated item has been removed. -
If the removal of the deprecated item is a breaking change, the merge request is labeled breaking change.
-
Mentions
-
Your stage's stable counterparts have been @mentioned
on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.- To see who the stable counterparts are for a product team visit product categories
- If there is no stable counterpart listed for Sales/CS please mention
@timtams
- If there is no stable counterpart listed for Support please mention
@gitlab-com/support/managers
- If there is no stable counterpart listed for Marketing please mention
@cfoster3
- If there is no stable counterpart listed for Sales/CS please mention
- To see who the stable counterparts are for a product team visit product categories
-
Your GPM has been @mentioned
so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.
Deprecation Milestone
Planned Removal Milestone
Links
Edited by Mario Celi