Skip to content

docs: document include prop for Schema component #3732

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

Merged
chdeskur merged 2 commits into from
Feb 23, 2026
Merged

docs: document include prop for Schema component #3732

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b14c789
docs: document include prop for Schema component
fern-api[bot] Feb 21, 2026
65acdc0
Update schema.mdx
chdeskur Feb 23, 2026
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
16 changes: 16 additions & 0 deletions fern/products/docs/pages/component-library/default-components/schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ The component works with [API references already configured in your `docs.yml`](
<Schema type="AIChatConfig" />
```

### Filtering fields

Use `include` to display only specific fields, or `exclude` to hide certain fields:

```jsx Markdown
{/* Only show these two fields */}
<Schema type="AIChatConfig" include={["model", "provider"]} />

{/* Show all fields except these */}
<Schema type="AIChatConfig" exclude={["model"]} />
```

## Properties

<ParamField path="type" type="string" required={true}>
Expand All @@ -39,6 +51,10 @@ The component works with [API references already configured in your `docs.yml`](
If `true`, includes the type definition's description above the schema fields. This is useful for displaying comments associated with the type, such as Protobuf message comments.
</ParamField>

<ParamField path="include" type="string[]" required={false}>
A list of field names to include in the rendered schema. When specified, only the listed fields will be displayed. This is useful when you want to explicitly control which fields appear, avoiding the need to update an `exclude` list whenever the underlying type gains new fields.
</ParamField>

<ParamField path="exclude" type="string[]" required={false}>
A list of field names to exclude from the rendered schema.
</ParamField>
Expand Down