summaryrefslogtreecommitdiff
path: root/lib/gitlab/graphql/docs/templates/default.md.haml
blob: b126a22c301168b5b5a3d02db87075a388b823f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
-# 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.
\
- objects.each do |type|
  - unless type[:fields].empty?
    = "## #{type[:name]}"
    - if type[:description]&.present?
      \
      = type[:description]
    \
    ~ "| Name  | Type  | Description |"
    ~ "| ---   |  ---- | ----------  |"
    - sorted_fields(type[:fields]).each do |field|
      = "| `#{field[:name]}` | #{render_field_type(field[:type][:info])} | #{field[:description]} |"
    \