Skip to content

docs: add layout.api-reference-expand-properties #6933

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
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add layout.api-reference-expand-properties #6933

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions fern/products/docs/pages/api-references/customize-api-ref.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ layout:
api-reference-layout: cards
```

Nested fields are collapsed behind a **Show N properties** button by default. To expand the first level on page load, set [`layout.api-reference-expand-properties`](/learn/docs/configuration/site-level-settings#layoutapi-reference-expand-properties) to `true`. Deeper levels stay collapsed.

```yaml title="docs.yml"
layout:
api-reference-expand-properties: true
```

### Renaming sections

By default, section display names come from tag names in your OpenAPI spec.
Expand Down
7 changes: 7 additions & 0 deletions fern/products/docs/pages/changelog/2026-09-11.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Expand nested properties by default

<ChangelogTags>api-reference, docs.yml</ChangelogTags>

You can now render the first level of nested object and union fields in your API Reference expanded on page load, so readers see request and response properties without selecting **Show N properties**. Deeper levels stay collapsed. Set `layout.api-reference-expand-properties: true` in `docs.yml` to enable it.

<Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/configuration/site-level-settings#layoutapi-reference-expand-properties">Read the docs</Button>
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 @@ -591,6 +591,7 @@ layout:
hide-feedback: true
changelog-layout: timeline
api-reference-layout: indented
api-reference-expand-properties: true
show-nav-availability-badges: true
```

Expand Down Expand Up @@ -672,6 +673,10 @@ layout:
Schemas with several levels of nesting benefit most from `indented`, where card borders otherwise stack into hard-to-follow frames.
</ParamField>

<ParamField path="layout.api-reference-expand-properties" type="boolean" required={false} default="false" toc={true}>
If set to true, the first level of nested object and union fields in the [API Reference](/learn/docs/api-references/generate-api-ref) renders expanded on page load instead of behind a **Show N properties** button. Deeper levels stay collapsed. Applies site-wide.
</ParamField>

<ParamField path="layout.show-nav-availability-badges" type="boolean" required={false} default="false" toc={true}>
If set to true, availability badges (Beta, Deprecated, etc.) are rendered inline next to navigation items in the sidebar (in addition to the badge rendered automatically in the page header).
</ParamField>
Expand Down
Loading