Commit 3189543e authored by Nick Thomas's avatar Nick Thomas

Merge branch 'cablett-graphql-deprecations' into 'master'

Process for Deprecation of GraphQL fields/tables

See merge request gitlab-org/gitlab!39584
parents 8e5e36a6 0f2c4561
...@@ -59,6 +59,23 @@ There are no plans to deprecate the REST API. To reduce the technical burden of ...@@ -59,6 +59,23 @@ There are no plans to deprecate the REST API. To reduce the technical burden of
supporting two APIs in parallel, they should share implementations as much as supporting two APIs in parallel, they should share implementations as much as
possible. possible.
### Deprecation process
Fields marked for removal from the GitLab GraphQL API are first **deprecated** but still available
for at least six releases, and then **removed entirely**.
Removals occur at X.0 and X.6 releases.
For example, a field can be marked as deprecated (but still usable) in %12.7, but can be used until its removal in %13.6.
When marked as deprecated, an alternative should be provided if there is one.
That gives consumers of the GraphQL API a minimum of six months to update their GraphQL queries.
The process is as follows:
1. The field is listed as deprecated in [GraphQL API Reference](reference/index.md).
1. Removals are announced at least one release prior in the Deprecation Warnings section of the
release post (at or prior to X.11 and X.5 releases).
1. Fields meeting criteria are removed in X.0 or X.6.
## Available queries ## Available queries
The GraphQL API includes the following queries at the root level: The GraphQL API includes the following queries at the root level:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment