Update API settings description to say that schema is not fixed
For guidance on the overall deprecations, removals and breaking changes workflow, please visit https://about.gitlab.com/handbook/product/gitlab-the-product/#breaking-changes-deprecations-and-removing-features
Deprecation Summary
In this discussion about removing an application setting from the API we came to the conclusion that the description for the application settings API is not clear. It says:
These API calls allow you to read and modify GitLab instance application settings as they appear in
/admin/application_settings/general
.
This can be interpreted as, the schema is bound to the UI, and it can be changed without notice if the UI changes. However, it is not saying this explicitly.
We want to change the description to clearly indicate that the schema for this endpoint is not fixed and can be changed at any time. This needs to be considered to be a breaking change so it needs to be announced two milestones ahead and can only be done in a major release.
Breaking Change
Please consider the API schema described in https://docs.gitlab.com/ee/api/settings as flexible. Fields and parameters can be added or removed without notice.
Affected Topology
All API users
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:
15.8, 15.9, 15.10, 16.0
–15.8
is the third milestone preceding the major release):-
A deprecation entry has been created so the deprecation will appear in release posts and on the general deprecation page. -
Documentation has been updated to add a note about the end-of-life and 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.