summaryrefslogtreecommitdiff
path: root/doc/api/graphql
diff options
context:
space:
mode:
authorPhil Hughes <me@iamphill.com>2019-05-09 10:27:07 +0100
committerBob Van Landuyt <bob@vanlanduyt.co>2019-05-28 10:22:02 +0200
commit11f85ae8c3b8ec5d864edd079e7c420a49cae72e (patch)
tree8da63219fc0977c7e132f7177bff20f41c997520 /doc/api/graphql
parent2cc6e6ff2628bd71faa71f083646a981ab2bcc11 (diff)
downloadgitlab-ce-11f85ae8c3b8ec5d864edd079e7c420a49cae72e.tar.gz
Enables GraphQL batch requests
Enabling GraphQL batch requests allows for multiple queries to be sent in 1 request reducing the amount of requests we send to the server. Responses come come back in the same order as the queries were provided.
Diffstat (limited to 'doc/api/graphql')
-rw-r--r--doc/api/graphql/index.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md
index 10e1ef0e533..9195ba4cdf1 100644
--- a/doc/api/graphql/index.md
+++ b/doc/api/graphql/index.md
@@ -48,6 +48,14 @@ A first iteration of a GraphQL API includes the following queries
1. `project` : Within a project it is also possible to fetch a `mergeRequest` by IID.
1. `group` : Only basic group information is currently supported.
+### Multiplex queries
+
+GitLab supports batching queries into a single request using
+[apollo-link-batch-http](https://www.apollographql.com/docs/link/links/batch-http). More
+info about multiplexed queries is also available for
+[graphql-ruby](https://graphql-ruby.org/queries/multiplex.html) the
+library GitLab uses on the backend.
+
## GraphiQL
The API can be explored by using the GraphiQL IDE, it is available on your