summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStan Hu <stanhu@gmail.com>2017-06-07 22:37:59 -0700
committerStan Hu <stanhu@gmail.com>2017-06-07 22:38:35 -0700
commitd540699b776630262c348a8399f8f31e8e778346 (patch)
treeda9e3b55725ffe13af1378e14cdd3f8a896a9c29
parentb845cfe8bc62e8ff925b64e78b229bef251ccf8d (diff)
downloadgitlab-ce-d540699b776630262c348a8399f8f31e8e778346.tar.gz
Add text documenting that v5 of the API will be GraphQLsh-document-road-to-graphql
[ci skip]
-rw-r--r--doc/api/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index e1d4009dedc..2175b305e02 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -55,6 +55,15 @@ following locations:
- [V3 to V4](v3_to_v4.md)
- [Version](version.md)
+## Road to GraphQL
+
+API v4 will be the last REST API that we support. Going forward, we will start
+on moving to GraphQL and deprecate the use of controller-specific
+endpoints. GraphQL has a number of benefits:
+
+1. We avoid having to maintain two different APIs.
+2. Callers of the API can request only what they need.
+
### Internal CI API
The following documentation is for the [internal CI API](ci/README.md):