docs: document send-optional-defaults playground setting - #6486
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 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:
|
|
🌿 Preview your docs: https://fern-preview-devin-1785517710-send-optional-defaults.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Claude Code Review
Claude Code Review is paused for this repository. To reconnect it, an admin of this repository's GitHub organization (or the account owner, for personal repositories) who can also manage your Claude organization's Code Review settings needs to re-link GitHub in Code Review settings. This is a one-time step.
Tip: disable this comment in your organization's Code Review settings.
Overview
Fern's API Explorer previously dropped the declared defaults of optional header, query, and path parameters, so readers had to type those values by hand on every request. A new opt-in
send-optional-defaultsplayground setting indocs.ymlmakes the Explorer pre-fill and send those defaults, so readers can run realistic requests out of the box. This matters for APIs that expect an optional header (for example a mock-response selector) on every call. It defaults tofalse, so existing docs sites are unaffected.Implements docs for: feat(docs): accept send-optional-defaults playground setting in docs.yml (fern-api/fern#17206) and feat(docs): honor default on optional playground params via send-optional-defaults (fern-api/fern-platform#13331).
Changes
fern/products/docs/pages/api-references/customize-api-ref.mdx: addedsend-optional-defaultsto the intro of Setting API Explorer options, a new Sending defaults for optional parameters section (behavior, default, where it can be set), and an entry under theplaygroundobject in the configuration options reference.fern/products/docs/pages/api-references/api-explorer.mdx: cross-reference from Autopopulate with examples to the new section.fern/products/docs/pages/changelog/2026-07-31.mdx: Docs changelog entry (api-reference,docs.yml).Preview: https://fern-preview-devin-1785517710-send-optional-defaults.docs.buildwithfern.com/learn/docs/api-references/customize-api-reference-layout#sending-defaults-for-optional-parameters
Verified with
pre-commit run(Vale: 0 errors; remaining warning/suggestion are on pre-existing lines) andfern check --warnings(0 errors).Link to Devin session: https://app.devin.ai/sessions/3a9c2221c0e8428786e6f8d20211b09e