kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Clarify API V5 being a compatability layer on top of GraphQL

Browse source 
[ci skip]
This commit is contained in:
Stan Hu 2017-06-08 13:34:18 -07:00
parent b1bf6d88fc
commit 5b645e6492
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/api/README.md
View file

@ -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