Skip to content

GraphQL docs: List all fields together in table

Luke Duncalfe requested to merge 417678-graphql-docs-list-all-fields-together into master

What does this MR do and why?

This change came out of this discussion: !125469 (comment 1462880836).

Previously, our generated GraphQL API docs will list all fields without arguments in a table, and then separately all fields with arguments below the table.

Particularly with large numbers of fields, this can make the discovery of a field with arguments difficult, as it appears much further below the table of fields.

This change lists all fields together in one table. Arguments for fields are documented below in sections and linked to from the main field entry.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #417678

Edited by Luke Duncalfe

Merge request reports