Deprecate GraphQL schema items for the Metrics Dashboard feature
Deprecation Summary
The Metrics Dashboard feature was deprecated in %14.7 and removed in %16.0. The related GraphQL fields should have been deprecated at the same time, but they were missed.
As of %16.0, these fields will return null values or fail silently. They will not be removed from the schema until %17.0 to give sufficient time for GraphQL users to adapt their API calls.
Breaking Change
If you use the GraphQL API, you can verify your API calls against the future schema to update your queries in advance of the removal.
Affected Topology
Any user-scripts calling the GraphQL API. UI-only users will not be impacted by the GraphQL schema changes.
Affected Tier
- Free
- Premium
- Ultimate
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
For GraphQL schema changes, removals happen in the next major version after a minimum of 6 releases. %16.6 is the earliest we could remove, so that puts this removal at %17.0.