Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 9, 2026

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.yml with a graphql spec (including resource and origin properties), and set up multiple GraphQL references.

Files changed:

  • generate-graphql-ref.mdx (new) — Main docs page, modeled after existing generate-openrpc-ref.mdx and generate-websocket-ref.mdx
  • 2026-02-09.mdx (new) — Changelog entry for the feature
  • docs.yml — Navigation entry added after OpenRPC reference in the API references section
  • Headings.yml — Added "GraphQL" as a Vale heading capitalization exception

Updates since last revision

  • Updated the primary generators.yml example to show multiple specs with unique resources (plants.schema.graphql → Plants, storefront.schema.graphql → Storefront) instead of a single spec
  • Updated origin property to describe it as a GraphQL API endpoint for introspection (rather than a generic remote URL), with an example of https://api.example.com/plants/graphql
  • Removed the docs.yml layout customization section per reviewer feedback
  • Added documentation for resource property (groups operations into a named folder in the sidebar) and origin property on the GraphQL spec object
  • Fixed Vale capitalization warnings

Review & Testing Checklist for Human

  • Verify the generators.yml configuration syntax — The api.specs[].graphql key and resource/origin properties 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.
  • Verify origin introspection behavior — The description states that Fern performs GraphQL introspection against the origin endpoint to fetch the schema. Confirm this is accurate and that no additional auth headers or configuration are needed (or document them if so).
  • Verify resource behavior — The description states that resource causes operations to appear within a folder of that name in the sidebar. Confirm this matches the actual behavior.
  • Consider adding a screenshot — Other similar pages (WebSocket, OpenRPC) include a <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.yml properties against the CLI implementation.

Notes

  • The page intentionally omits a <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.
  • Vale passes clean on all changed files.

Requested by: Fern Support
Link to Devin run

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@@ -0,0 +1,75 @@
---
title: Generate GraphQL reference
description: Learn how to generate and customize GraphQL API reference documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

@chdeskur chdeskur merged commit 7c363b8 into main Feb 9, 2026
1 check failed
@chdeskur chdeskur deleted the fern/graphql-api-reference-docs branch February 9, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants