summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorFilipa Lacerda <filipa@gitlab.com>2017-06-08 22:49:14 +0100
committerFilipa Lacerda <filipa@gitlab.com>2017-06-08 22:49:14 +0100
commit08aff6fb92e8e59d6a818342201ecbbeee19dbe0 (patch)
tree1330be3b351e6d7b1375659f8e32113c8979fb55 /doc/api
parent081f48fb0641758acc524d9e171784a9a6923b5a (diff)
parentedd8d91194ce79cb5d77973c40436b98eb4d97fc (diff)
downloadgitlab-ce-33466-jobs-navigation-menu.tar.gz
Merge branch 'master' into 33466-jobs-navigation-menu33466-jobs-navigation-menu
* master: Clarify API V5 being a compatability layer on top of GraphQL Update per discussion Use RequestStore on MR show.json query count spec Merge branch '25934-project-snippet-vis' into 'security-9-2' Merge branch 'dz-api-x-frame' into 'security-9-2' Merge branch 'dz-restrict-autocomplete' into 'security-9-1' Merge branch 'cherry-pick-dc2ac993' into 'security-9-2' Update rename_system_namespace_spec to new validations. Make the uploader use the updated folder Bring in security changes from the 9.2.5 release Bring in security changes from the 9.2.5 release GitLab GEO also does not support mysql replication
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 2175b305e02..1241801a81c 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -57,12 +57,16 @@ following locations:
## 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:
+Going forward, we will start on moving to
+[GraphQL](http://graphql.org/learn/best-practices/) 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.
+3. It is versioned by default.
+
+It will co-exist with the current V4 REST API. If we have a V5 API, this should be
+compatability layer on top of GraphQL.
### Internal CI API