From d540699b776630262c348a8399f8f31e8e778346 Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Wed, 7 Jun 2017 22:37:59 -0700 Subject: Add text documenting that v5 of the API will be GraphQL [ci skip] --- doc/api/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) 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): -- cgit v1.2.1