Add GraphQL API Reference documentation #3542
Merged
+93
−0
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.
Add GraphQL API Reference documentation
Summary
Adds a new documentation page for the GraphQL API Reference feature, along with a changelog entry and supporting config updates. The page documents how to configure
generators.ymlwith agraphqlspec (includingresourceandoriginproperties), and set up multiple GraphQL references.Files changed:
generate-graphql-ref.mdx(new) — Main docs page, modeled after existinggenerate-openrpc-ref.mdxandgenerate-websocket-ref.mdx2026-02-09.mdx(new) — Changelog entry for the featuredocs.yml— Navigation entry added after OpenRPC reference in the API references sectionHeadings.yml— Added "GraphQL" as a Vale heading capitalization exceptionUpdates since last revision
generators.ymlexample to show multiple specs with unique resources (plants.schema.graphql→ Plants,storefront.schema.graphql→ Storefront) instead of a single specoriginproperty to describe it as a GraphQL API endpoint for introspection (rather than a generic remote URL), with an example ofhttps://api.example.com/plants/graphqldocs.ymllayout customization section per reviewer feedbackresourceproperty (groups operations into a named folder in the sidebar) andoriginproperty on the GraphQL spec objectReview & Testing Checklist for Human
generators.ymlconfiguration syntax — Theapi.specs[].graphqlkey andresource/originproperties were documented based on the CLI changelog (3.56.8) and reviewer guidance, not from source code. Confirm the property names, nesting, and indentation match the actual implementation.originintrospection behavior — The description states that Fern performs GraphQL introspection against theoriginendpoint to fetch the schema. Confirm this is accurate and that no additional auth headers or configuration are needed (or document them if so).resourcebehavior — The description states thatresourcecauses operations to appear within a folder of that name in the sidebar. Confirm this matches the actual behavior.<Frame>with a screenshot. This page omits one since no live example site was available. Add one if a customer example exists.Suggested test plan: Open the preview link, verify the page renders correctly, and cross-check the
generators.ymlproperties against the CLI implementation.Notes
<Markdown src="/snippets/pro-plan.mdx"/>callout since the WebSocket page has one but the OpenRPC page does not — confirm whether GraphQL references require Pro/Enterprise.Requested by: Fern Support
Link to Devin run