diff options
| author | Douwe Maan <douwe@gitlab.com> | 2017-06-08 20:49:07 +0000 |
|---|---|---|
| committer | Douwe Maan <douwe@gitlab.com> | 2017-06-08 20:49:07 +0000 |
| commit | b670f21c9b75b8a5209a8b223602c826d66aacc7 (patch) | |
| tree | b9db2a43826133e165d9d7684258e3a44be385ad | |
| parent | b1bf6d88fceb24663bfe4be2d9cc111710d9126b (diff) | |
| parent | 5b645e64928662f2166542b89f11246399faa540 (diff) | |
| download | gitlab-ce-b670f21c9b75b8a5209a8b223602c826d66aacc7.tar.gz | |
Merge branch 'sh-clarify-graphql' into 'master'
Clarify API V5 being a compatability layer on top of GraphQL
See merge request !12030
| -rw-r--r-- | doc/api/README.md | 10 |
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 |