Document direct API spec references in docs.yml - #6997
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
devin-ai-integration
Bot
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 17, 2026 17:10
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| </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. |
Contributor
There was a problem hiding this comment.
📝 [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. |
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1789664942-docs-yml-direct-specs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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
API reference navigation items in
docs.ymlcan now point straight at OpenAPI, AsyncAPI, or GraphQL spec files via a new optionalspecslist on theapi:item, instead of relying on the API being discovered throughgenerators.yml. This matters for docs-only projects: the docs config owns its spec references and nogenerators.ymlis needed. Whenspecsis omitted, the existingapi-namebehaviour is unchanged.Implements docs for: feat(docs): support direct API spec references (fern-api/fern#17749)
Field names (
type,path,namespace,overlays,overrides) followApiSpecConfigurationin the source PR'sdocs.ymlschema.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 toapi-name.fern/products/docs/pages/api-references/generate-graphql-ref.mdx,generate-websocket-ref.mdx: one-line pointer fortype: graphql/type: asyncapi.fern/products/docs/pages/changelog/2026-09-17.mdx: Docs changelog entry.Vale and
fern check --warningspass (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