diff --git a/api-playground/graphql-setup.mdx b/api-playground/graphql-setup.mdx index 0ae3abbc2..6793b0bf5 100644 --- a/api-playground/graphql-setup.mdx +++ b/api-playground/graphql-setup.mdx @@ -92,10 +92,12 @@ Mintlify organizes generated pages into three sections under the tab or group yo - **Queries**: One page per field on your `Query` root type. - **Mutations**: One page per field on your `Mutation` root type. -- **Types**: One page per named object, input, enum, interface, or union type. +- **Types**: One page per named object, input, enum, interface, union, or custom scalar type. On a tab, the sections appear after any groups you define. On a group, they appear as nested groups after any pages you list. +Page URLs use each name as written, such as `graphql-reference/types/Cart`. If two names differ only by case, such as `StoreFrontConfigType` and `StorefrontConfigType`, the name that sorts first keeps that URL and the other uses a kebab-case URL, such as `graphql-reference/types/storefront-config-type`. The build logs a warning for each name that gets a new URL. + Each operation page shows the field description, arguments, return type, and links to any referenced types. Query and mutation pages also include a generated example operation, the required variables, and a sample JSON response. Type pages render the schema definition read-only, with linked field types so readers can navigate the graph. @@ -133,7 +135,7 @@ A selector is a kind followed by a name, separated by a space: - `QUERY `: A field on your `Query` root type. - `MUTATION `: A field on your `Mutation` root type. -- `TYPE `: A named object, input, enum, interface, or union type. +- `TYPE `: A named object, input, enum, interface, union, or custom scalar type. Selector kinds must be uppercase. Use a dotted path, such as `MUTATION cart.createCart`, to select an operation nested under a namespace field. `TYPE` selectors do not accept dotted paths.