Skip to content

Commit 45615d0

Browse files
committed
adjust schema component page text
1 parent 14f3722 commit 45615d0

File tree

1 file changed

+9
-9
lines changed
  • fern/products/docs/pages/component-library/default-components

1 file changed

+9
-9
lines changed

fern/products/docs/pages/component-library/default-components/schema.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@ title: Schema
33
description: Display any type definition from your API Reference
44
---
55

6-
The `<Schema>` component displays type definitions from your API Reference. Use it to render any type schema directly in your documentation pages, making it easy to reference data models, request objects, or response types throughout your docs.
6+
The `<Schema>` component displays type definitions from your API Reference anywhere in your documentation. Use it to reference data models, request objects, or response types outside of your API Reference pages.
77

8-
This component is similar to [`<EndpointSchemaSnippet>`](/docs/writing-content/components/endpoint-schema-snippet), but accepts any type name rather than being limited to endpoint-specific schemas.
8+
Similar to [`<EndpointSchemaSnippet>`](/docs/writing-content/components/endpoint-schema-snippet), but accepts any type name rather than being limited to endpoint-specific schemas. The component only discovers types referenced by endpoints. Types exclusively used by websockets/webhooks won't be available.
99

10+
## Usage
11+
12+
<Info>
1013
Before using the `<Schema>` component, you must reference the API in your `docs.yml` file:
1114

1215
```yaml docs.yml
1316
- api: API reference
14-
api-name: docs-yml
17+
api-name: docs-yml
1518
```
16-
17-
<Note>
18-
The Schema component can only discover types that are referenced by endpoints in your API definition. Types exclusively referenced by websockets/webhooks or types that aren't referenced at all won't be available.
19-
</Note>
20-
21-
## Usage
19+
</Info>
2220
2321
<div className="highlight-frame">
22+
<div className="highlight-frame-content">
2423
<Schema type="AIChatConfig" />
24+
</div>
2525
</div>
2626
2727
```jsx Markdown

0 commit comments

Comments
 (0)