debian-mirror-gitlab/lib/gitlab/graphql/docs/templates/default.md.haml

30 lines
842 B
Text
Raw Normal View History

2019-09-30 21:07:59 +05:30
-# 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-03-13 15:44:24 +05:30
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.
2020-04-08 14:13:33 +05:30
CAUTION: **Caution:**
Fields that are deprecated are marked with **{warning-solid}**.
2019-09-30 21:07:59 +05:30
\
- objects.each do |type|
- unless type[:fields].empty?
2020-03-13 15:44:24 +05:30
= "## #{type[:name]}"
- if type[:description]&.present?
\
= type[:description]
2019-09-30 21:07:59 +05:30
\
~ "| Name | Type | Description |"
~ "| --- | ---- | ---------- |"
2020-03-13 15:44:24 +05:30
- sorted_fields(type[:fields]).each do |field|
2020-04-08 14:13:33 +05:30
= render_field(field)
2019-09-30 21:07:59 +05:30
\