Repository navigation
docs: document SDK snippets from sdk-config.yml builds - #7680
Merged
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1793305914-sdk-config-snippets.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Contributor
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…ture Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Postman-AdiBarHalevi
approved these changes
Oct 30, 2026
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…ve project structure to its own PR Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
nerminamiller-postman
marked this pull request as ready for review
November 2, 2026 17:54
nerminamiller-postman
requested a review
from jkonrath-postman
as a code owner
November 2, 2026 17:54
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
nerminamiller-postman
deleted the
devin/1793305914-sdk-config-snippets
branch
November 2, 2026 19:09
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
Documents the sdk-gen SDK snippets feature from fern-api/fern#18480 and fern-api/fern#18512. The
FERN_UPLOAD_SDK_GEN_SNIPPETSgate was removed in CLI 5.188.0 (fern-api/fern#18679), so this PR no longer needs to be held. The steps follow Adi's setup instructions.Display SDK snippets (
api-references/sdk-snippets.mdx)Setup now has tabs, one per config file:
sdk-config.ymltab, step by step:docs.snippets.enabled: trueinsdk-config.yml.docs.yml, under theapi:entry, addsnippets.<lang>withpackageandversionfor each language you build. Use the version you're about to build, and list only languages you build.fern generatewith a new version that matchesdocs.yml.fern generate --docs. On success the output showsLoaded SDK snippets (<lang>: N, ...).fern generate --docsfetches them (per Adi's review).sdkName, language andversion.sdk-config.yml" H2. Its anchor is gone, so thesdk-config.ymlreference now links to#enable-snippets-in-sdk-configyml.sdk-config.ymlreferencedocs.snippetslinks to the new setup steps.### snippetssubsection withenabled,format(md | json) andoutputPath, taken from the@postman/sdk-config0.17.0 schema.Moved out: the Docs project structure changes are now in their own PR (#7704), because they don't depend on the flag.
Left out on purpose: the
FERN_UPLOAD_SDK_GEN_SNIPPETSexport (ignored since 5.188.0) andfern-beta(the flag removal shipped in the stablefernCLI).Checked against fern-api/fern main (CLI code and tests)
docs.snippets.format/outputPath: the CLI never reads them. It reads only the artifact'splaceholdersSnippetsUrlfrom sdk-gen-api and parses it assnippets.json. Whether sdk-gen honors them when it writes that file is server-side and not verifiable here.experimental.dynamic-snippets: false: turns off only Fern's dynamic IR. sdk-gen snippets are attached inregisterApiToFdrbefore and regardless of that check.getSdkRequestsasks sdk-gen for everytargetLanguageSchemalanguage exceptcli,mcpandterraform, so Swift and Rust are requested too (test: "reads the other SDK languages too, but not the targets that are not SDKs"). Kotlin has nodocs.ymlsnippetskey. The CLI changelog names only the seven languages the docs list.Still open for the developer (@Postman-AdiBarHalevi)
formatoroutputPathchange theplaceholdersSnippetsUrlfile?Link to Devin session: https://app.devin.ai/sessions/de4b9751dd454ba1bcd0ad4d33e3dc72
Open in Devin Desktop: https://app.devin.ai/desktop/session/de4b9751dd454ba1bcd0ad4d33e3dc72?variant=devin
Requested by: @nerminamiller-postman