Update from code changes: document GraphQL API reference setup#6699
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Update from code changes updated this PR. No docs changes made Source PRs
|
ethanpalm
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new setup guide for generating GraphQL API reference pages from an SDL schema. Documents the
graphqltab property, the local file and HTTPS URL forms, the optionaldirectoryfield, and what gets generated (queries, mutations, and types with linked schema, example operations, variables, and JSON responses).Triggered by:
Changes
api-playground/graphql-setup.mdxcovering schema requirements, configuration options, generated pages, and deprecation handling.docs.json.es,fr, andzh.Update history
es,fr,zhand updated their nav JSONs.Note
Low Risk
Documentation and navigation-only changes with no runtime or product behavior impact.
Overview
Adds GraphQL setup documentation so customers can generate API reference pages from an SDL schema via the
graphqltab property indocs.json.The new English page (
api-playground/graphql-setup.mdx) covers schema requirements, configuration as a string path/HTTPS URL or{ source, directory }, tab-only constraints (no mixing withopenapi/asyncapi), what Mintlify generates (Queries, Mutations, Types with examples and linked types),@deprecatedhandling, and rebuild behavior. It is wired into the Document APIs group indocs.json.The same guide is added for es, fr, and zh (
*/api-playground/graphql-setup.mdx) with matching navigation entries ines.json,fr.json, andzh.json.Reviewed by Cursor Bugbot for commit f5161f9. Bugbot is set up for automated code reviews on this repo. Configure here.