Add deprecation note about revoked tokens to the Cluster Agent Tokens API endpoints
For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features
This came up from these discussions:
Deprecation Summary
Currently, the Cluster Agents API -> Agent Tokens endpoints return the revoked tokens on GET requests.
We (~"group::configure") came to the agreement that, in the medium term (ie next major milestone), revoked tokens should not be shown/included in the APIs (REST and GraphQL) and the UI.
In the short term, a deprecation note should be added to indicate that the behavior of these endpoints will change:
- REST API
- List tokens - documentation | code
- Get a single token - documentation | code
- GraphQL
-
ClusterAgent.tokens
- documentation | code
-
Notes from deprecation issue template:
The description of the deprecation should state what actions the user should take to rectify the behavior. If the deprecation is scheduled for an upcoming release, the content should remain in the deprecations documentation page until it has been completed. For example, if a deprecation is announced in 14.9 and scheduled to be completed in 15.0, the same content would be included in the documentation for 14.9, 14.10, and 15.0.
Breaking Change
Users should review their calls to these endpoints and check if they are using the revoked tokens.
- REST API List tokens
- REST API Get a single token API endpoints .
- GraphQL
ClusterAgent.tokens
Affected Topology
This affects self-managed and SaaS users
Affected Tier
- 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.