2019-07-11 04:06:35 -04:00
|
|
|
-# haml-lint:disable UnnecessaryStringOutput
|
|
|
|
|
|
|
|
= auto_generated_comment
|
|
|
|
|
|
|
|
:plain
|
|
|
|
# GraphQL API Resources
|
|
|
|
|
|
|
|
This documentation is self-generated based on GitLab current GraphQL schema.
|
|
|
|
|
|
|
|
The API can be explored interactively using the [GraphiQL IDE](../index.md#graphiql).
|
|
|
|
|
2020-01-08 22:07:56 -05:00
|
|
|
Each table below documents a GraphQL type. Types match loosely to models, but not all
|
|
|
|
fields and methods on a model are available via GraphQL.
|
2019-07-11 04:06:35 -04:00
|
|
|
\
|
|
|
|
- objects.each do |type|
|
|
|
|
- unless type[:fields].empty?
|
2020-01-08 22:07:56 -05:00
|
|
|
= "## #{type[:name]}"
|
|
|
|
- if type[:description]&.present?
|
|
|
|
\
|
|
|
|
= type[:description]
|
2019-07-11 04:06:35 -04:00
|
|
|
\
|
|
|
|
~ "| Name | Type | Description |"
|
|
|
|
~ "| --- | ---- | ---------- |"
|
2020-01-24 01:08:51 -05:00
|
|
|
- sorted_fields(type[:fields]).each do |field|
|
2019-07-11 04:06:35 -04:00
|
|
|
= "| `#{field[:name]}` | #{render_field_type(field[:type][:info])} | #{field[:description]} |"
|
|
|
|
\
|