Skip to content

Document direct API spec references in docs.yml - #6997

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789664942-docs-yml-direct-specs
Open

devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789664942-docs-yml-direct-specs

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

API reference navigation items in docs.yml can now point straight at OpenAPI, AsyncAPI, or GraphQL spec files via a new optional specs list on the api: item, instead of relying on the API being discovered through generators.yml. This matters for docs-only projects: the docs config owns its spec references and no generators.yml is needed. When specs is omitted, the existing api-name behaviour is unchanged.

Implements docs for: feat(docs): support direct API spec references (fern-api/fern#17749)

Field names (type, path, namespace, overlays, overrides) follow ApiSpecConfiguration in the source PR's docs.yml schema.

Pages changed:

  • fern/products/docs/pages/api-references/generate-api-ref.mdx: new "Reference a spec directly from docs.yml" subsection with example and field list.
  • fern/products/docs/pages/api-references/customize-api-ref.mdx: specs <ParamField> next to api-name.
  • fern/products/docs/pages/api-references/generate-graphql-ref.mdx, generate-websocket-ref.mdx: one-line pointer for type: graphql / type: asyncapi.
  • fern/products/docs/pages/changelog/2026-09-17.mdx: Docs changelog entry.

Vale and fern check --warnings pass (remaining warnings are pre-existing).

Link to Devin session: https://app.devin.ai/sessions/60634817a1d9468bb2ba97ca6d7def30
Open in Devin Desktop: https://app.devin.ai/desktop/session/60634817a1d9468bb2ba97ca6d7def30?variant=devin

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
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, CI, and merge conflict monitoring

</ParamField>

<ParamField path="specs" toc={true} type="list<object>">
API specification files to [load directly from docs.yml](/learn/docs/api-references/generate-api-ref#reference-a-spec-directly-from-docsyml) instead of through `generators.yml`. Each entry has a `type` (`openapi`, `asyncapi`, or `graphql`) and a `path`, plus optional `overrides`, `overlays`, and `namespace`. Paths are relative to the configuration file that contains them. When set, `api-name` is ignored.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] <FernStyles.Hyphens> reported by reviewdog 🐶
'directly-from' doesn't need a hyphen.

Suggested change
API specification files to [load directly from docs.yml](/learn/docs/api-references/generate-api-ref#reference-a-spec-directly-from-docsyml) instead of through `generators.yml`. Each entry has a `type` (`openapi`, `asyncapi`, or `graphql`) and a `path`, plus optional `overrides`, `overlays`, and `namespace`. Paths are relative to the configuration file that contains them. When set, `api-name` is ignored.
API specification files to [load directly from docs.yml](/learn/docs/api-references/generate-api-ref#reference-a-spec-directly from-docsyml) instead of through `generators.yml`. Each entry has a `type` (`openapi`, `asyncapi`, or `graphql`) and a `path`, plus optional `overrides`, `overlays`, and `namespace`. Paths are relative to the configuration file that contains them. When set, `api-name` is ignored.

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.

0 participants