docs(docs-yml): document settings.show-headers-in-examples - #6979
Open
willkendall01 wants to merge 1 commit into
Open
willkendall01 wants to merge 1 commit into
willkendall01 wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
willkendall01
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 16, 2026 18:31
Contributor
🤖 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:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1789583487-docs-show-headers-in-examples.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
Documents the new
settings.show-headers-in-examplesdocs.yml setting (added in fern-api/fern#17714, rendered by fern-api/fern-platform#14635).Adds a
settings.show-headers-in-examplesParamFieldto the site-level settings reference and the key to thesettings:example block. When enabled, API Reference response examples gain a raw HTTP block — status line plus oneName: valueline per declared response header — above the response body; responses with no declared headers render unchanged. Defaults tofalse.The setting is not yet released: this PR can land ahead of the CLI/fern-platform changes or after, either order is safe since the docs just describe opt-in behavior.
Link to Devin session: https://app.devin.ai/sessions/292f16cc84c14e258f002d7545edb9f1
Open in Devin Desktop: https://app.devin.ai/desktop/session/292f16cc84c14e258f002d7545edb9f1?variant=devin
Requested by: @willkendall01