Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
willkendall01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions fern/products/docs/pages/navigation/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,6 +748,7 @@ settings:
prioritize-current-product: true
default-filter-by-current-product: true
http-snippets: false
show-headers-in-examples: false
hide-404-page: true
use-javascript-as-typescript: false
folder-title-source: frontmatter
Expand Down Expand Up @@ -809,6 +810,10 @@ settings:
```
</ParamField>

<ParamField path="settings.show-headers-in-examples" type="boolean" required={false} default="false" toc={true}>
If set to true, response examples in the API Reference include a raw HTTP block listing the response's declared headers — the status line plus one `Name: value` line per header — above the response body. Responses whose spec declares no headers render unchanged.
</ParamField>

<ParamField path="settings.hide-404-page" type="boolean" required={false} default="false" toc={true}>
If set to true, when a user navigates to a page that doesn't exist, they will be redirected to the home page.

Expand Down
Loading