BigW Consortium Gitlab

Skip to content

G
gitlab-ce
Commit b670f21c by Douwe Maan
Options

Merge branch 'sh-clarify-graphql' into 'master'

Clarify API V5 being a compatability layer on top of GraphQL See merge request !12030
parents b1bf6d88 5b645e64
Showing with 7 additions and 3 deletions
doc/api/README.md
...@@ -57,12 +57,16 @@ following locations: ...@@ -57,12 +57,16 @@ following locations:
## Road to GraphQL ## Road to GraphQL
API v4 will be the last REST API that we support. Going forward, we will start Going forward, we will start on moving to
on moving to GraphQL and deprecate the use of controller-specific [GraphQL](http://graphql.org/learn/best-practices/) and deprecate the use of
endpoints. GraphQL has a number of benefits: controller-specific endpoints. GraphQL has a number of benefits:
1. We avoid having to maintain two different APIs. 1. We avoid having to maintain two different APIs.
2. Callers of the API can request only what they need. 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 ### Internal CI API
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment