Download Gitlab’s graphql schema

Question

I’m trying to get hold of gitlab_schema.graphql, i.e. the schema for Gitlab’s graphql API. Can’t find it anywhere, does anyone have any pointers?

score 2 · Accepted Answer · 2021-09-18 12:49:29Z

2

I found the schema is an artifact in the Gitlab CI pipe (graphql-schema-dump job), for example here: https://gitlab.com/gitlab-org/gitlab/-/jobs/1602029144.

Not perfect, but works.

answered Sep 18, 2021 at 12:49

Fredrik Jansson

3,7843 gold badges30 silver badges33 bronze badges

Petr PlenkovPetr Plenkov 916 bronze badges · Accepted Answer · 2021-11-01 12:20:13Z

1

You can use apollo CLI for this: apollo client:download-schema --endpoint=https://gitlab.yourcompany.com/api/graphql schema.graphql or just omit filename and it will download to JSON

answered Nov 1, 2021 at 12:20

Petr Plenkov

916 bronze badges

Adam MarshallAdam Marshall 6,6112 gold badges30 silver badges45 bronze badges · Accepted Answer · 2021-09-16 18:03:30Z

0

It doesn’t look like GitLab shares the schema directly, just this Reference Documentation generated from the schema, and the GraphiQL Explorer / IDE (more info about GraphiQL Explorer here).

answered Sep 16, 2021 at 18:03

Adam Marshall

6,6112 gold badges30 silver badges45 bronze badges

2

Yeah, which is really weird.. was hoping to use a rust lib (crates.io/crates/graphql_client) to avoid manually hacking the queries, but maybe I'll end up doing just that.

– Fredrik Jansson

Sep 16, 2021 at 19:25
Agreed. I didn't find any issues about it when searching, but they're pretty good about responding there if you want to open one.

– Adam Marshall

Sep 16, 2021 at 19:27

Raymond TayRaymond Tay 814 bronze badges · Accepted Answer · 2023-01-24 12:44:40Z

Here’s alternative, if you are working with Rust lang. For Rust developers, you need to install the crate named graphql_client_cli via cargo. Example: cargo install graphql_client_cli.

Next, you can run the graphql client you just downloaded, to get the schema (either in JSON or GraphQL format). Example: graphql-client --authorization 'Bearer <bearer token>' https://<your gitlab url site>/api/graphql.

See the GraphQL Client CLI for more options.

user3033411user3033411 434 bronze badges · Accepted Answer · 2023-11-02 20:33:38Z

0

I found a direct download here

answered 1 hour ago

user3033411

434 bronze badges

Download Gitlab’s graphql schema