diff options
author | Evan Read <eread@gitlab.com> | 2019-07-10 18:11:06 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-07-10 18:11:06 +0000 |
commit | 877395b17b7b5c0c805e07ece6dfe7395a7af82e (patch) | |
tree | 7968b02fea601cc4e1d1b88168e1f3ef4f0f71af /doc/api | |
parent | 8a6a1c8f9fcbfe0446440e11e000acf931584a06 (diff) | |
download | gitlab-ce-877395b17b7b5c0c805e07ece6dfe7395a7af82e.tar.gz |
Edit GraphQL general availability text
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/README.md | 7 | ||||
-rw-r--r-- | doc/api/graphql/index.md | 6 |
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 3ded230370c..b2bb55f2fcf 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -154,9 +154,10 @@ the `/Users` endpoint. The base URL is: `/api/scim/v2/groups/:group_path/Users/` ## Road to GraphQL -Going forward, we will start on moving to -[GraphQL](graphql/index.md) and deprecate the use of -controller-specific endpoints. GraphQL has a number of benefits: +[GraphQL](graphql/index.md) is available in GitLab, which will +allow deprecation of controller-specific endpoints. + +GraphQL has a number of benefits: 1. We avoid having to maintain two different APIs. 1. Callers of the API can request only what they need. diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index db073321808..4e4b9418e47 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -1,6 +1,8 @@ # GraphQL API -> [Introduced][ce-19008] in GitLab 11.0. +> - [Introduced][ce-19008] in GitLab 11.0 (enabled by feature flag `graphql`). +> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/30444) + in GitLab 12.1. [GraphQL](https://graphql.org/) is a query language for APIs that allows clients to request exactly the data they need, making it @@ -29,8 +31,6 @@ 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 possible. -As of the 12.1 release, GraphQL is always enabled. - ## Available queries A first iteration of a GraphQL API includes the following queries |