diff --git a/fern/products/docs/pages/component-library/default-components/schema.mdx b/fern/products/docs/pages/component-library/default-components/schema.mdx index 36e98ad1a..3f3b7dc4e 100644 --- a/fern/products/docs/pages/component-library/default-components/schema.mdx +++ b/fern/products/docs/pages/component-library/default-components/schema.mdx @@ -25,6 +25,18 @@ The component works with [API references already configured in your `docs.yml`]( ``` +### Filtering fields + +Use `include` to display only specific fields, or `exclude` to hide certain fields: + +```jsx Markdown +{/* Only show these two fields */} + + +{/* Show all fields except these */} + +``` + ## Properties @@ -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. + + 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. + + A list of field names to exclude from the rendered schema.