Skip to content

docs: fix incorrect claim about Schema component type discovery #3432

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

Closed
Ryan-Amirthan wants to merge 1 commit into from
Closed

docs: fix incorrect claim about Schema component type discovery #3432

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
4 changes: 2 additions & 2 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 @@ -8,7 +8,7 @@ The `<Schema>` component displays type definitions from your API Reference anywh
Similar to [`<EndpointSchemaSnippet>`](/learn/docs/writing-content/components/endpoint-schema-snippet), but accepts any type name rather than being limited to endpoint-specific schemas. Pair with [`<SchemaSnippet>`](/learn/docs/writing-content/components/schema-snippet) to display the JSON representation alongside the field breakdown.

<Note>
The component only discovers types referenced by endpoints. Types exclusively used by websockets or webhooks won't be available. If multiple APIs have the same type name, the component returns the first match.
The component discovers types from your API definition, including those referenced by endpoints, webhooks, and websockets. Types must be defined as named schemas in your OpenAPI spec (under `components/schemas`) to be discoverable. Inline schemas that aren't extracted as named types won't be available. If multiple APIs have the same type name, the component returns the first match.
</Note>

## Usage
Expand All @@ -28,7 +28,7 @@ The component works with [API references already configured in your `docs.yml`](
## Properties

<ParamField path="type" type="string" required={true}>
The name of the type to display. The component will search for this type across all endpoints in your API definition.
The name of the type to display. The component searches for this type across all named schemas in your API definition.
</ParamField>

<ParamField path="className" type="string" required={false}>
Expand Down
Loading