61 lines
1.9 KiB
Text
61 lines
1.9 KiB
Text
-# 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).
|
|
|
|
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.
|
|
|
|
WARNING:
|
|
Fields that are deprecated are marked with **{warning-solid}**.
|
|
Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-process) can be found
|
|
in [Removed Items](../removed_items.md).
|
|
\
|
|
|
|
:plain
|
|
## Object types
|
|
|
|
Object types represent the resources that the GitLab GraphQL API can return.
|
|
They contain _fields_. Each field has its own type, which will either be one of the
|
|
basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types)
|
|
(e.g.: `String` or `Boolean`) or other object types.
|
|
|
|
For more information, see
|
|
[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields)
|
|
on `graphql.org`.
|
|
\
|
|
|
|
- objects.each do |type|
|
|
- unless type[:fields].empty?
|
|
= render_name_and_description(type)
|
|
~ "| Field | Type | Description |"
|
|
~ "| ----- | ---- | ----------- |"
|
|
- sorted_by_name(type[:fields]).each do |field|
|
|
= render_field(field)
|
|
\
|
|
|
|
:plain
|
|
## Enumeration types
|
|
|
|
Also called _Enums_, enumeration types are a special kind of scalar that
|
|
is restricted to a particular set of allowed values.
|
|
|
|
For more information, see
|
|
[Enumeration Types](https://graphql.org/learn/schema/#enumeration-types)
|
|
on `graphql.org`.
|
|
\
|
|
|
|
- enums.each do |enum|
|
|
- unless enum[:values].empty?
|
|
= render_name_and_description(enum)
|
|
~ "| Value | Description |"
|
|
~ "| ----- | ----------- |"
|
|
- sorted_by_name(enum[:values]).each do |value|
|
|
= render_enum_value(value)
|
|
\
|