Skip to content

docs(docs-yml): document settings.show-headers-in-examples - #6979

Open
willkendall01 wants to merge 1 commit into
mainfrom
devin/1789583487-docs-show-headers-in-examples
Open

willkendall01 wants to merge 1 commit into
mainfrom
devin/1789583487-docs-show-headers-in-examples

Conversation

@willkendall01

Copy link
Copy Markdown
Contributor

Summary

Documents the new settings.show-headers-in-examples docs.yml setting (added in fern-api/fern#17714, rendered by fern-api/fern-platform#14635).

Adds a settings.show-headers-in-examples ParamField to the site-level settings reference and the key to the settings: example block. When enabled, API Reference response examples gain a raw HTTP block — status line plus one Name: value line per declared response header — above the response body; responses with no declared headers render unchanged. Defaults to false.

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

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

Copy link
Copy Markdown
Contributor

🤖 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

@github-actions

Copy link
Copy Markdown
Contributor

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.

1 participant