From 5f8f12fd79e957f50e2854a458cf88abb1fcb7ba Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 26 Nov 2025 18:14:01 -0500 Subject: [PATCH] document schema component --- fern/products/docs/docs.yml | 6 ++++ .../docs/pages/changelog/2025-11-26.mdx | 17 +++++++++ .../endpoint-schema-snippet.mdx | 2 ++ .../default-components/overview.mdx | 9 ++++- .../default-components/schema.mdx | 36 +++++++++++++++++++ .../overview/php/changelog/2025-11-25.mdx | 2 +- 6 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 fern/products/docs/pages/changelog/2025-11-26.mdx create mode 100644 fern/products/docs/pages/component-library/default-components/schema.mdx diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index fbcabce93..5ab38f670 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -111,6 +111,9 @@ navigation: - page: Runnable endpoint path: ./pages/component-library/default-components/runnable-endpoint.mdx icon: fa-duotone fa-play-circle + - page: Schema + path: ./pages/component-library/default-components/schema.mdx + icon: fa-duotone fa-brackets-curly - page: Step path: ./pages/component-library/default-components/steps.mdx icon: fa-duotone fa-list-ol @@ -325,4 +328,7 @@ navigation: paginated: false api-name: mcp-tools slug: fern-api-reference + # must be included to use the schema component + - api: API reference + api-name: docs-yml diff --git a/fern/products/docs/pages/changelog/2025-11-26.mdx b/fern/products/docs/pages/changelog/2025-11-26.mdx new file mode 100644 index 000000000..db06c2e11 --- /dev/null +++ b/fern/products/docs/pages/changelog/2025-11-26.mdx @@ -0,0 +1,17 @@ +## Schema component + +The new `` 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. + +This example displays the `AIChatConfig` type from the `docs-yml` API: + +
+
+ +
+
+ +```jsx Markdown + +``` + +[Learn more](/docs/writing-content/components/schema) about the Schema component. diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx index 563fc8ed1..45ec92090 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx @@ -5,6 +5,8 @@ description: 'Reference an endpoint schema from your API Reference' The `` component displays endpoint schemas from your API Reference. By default, it renders the complete schema, or you can use the `selector` prop to display specific parts like request body, response, path parameters, or query parameters. +To display any type definition by name (not limited to endpoint schemas), use the [``](/docs/writing-content/components/schema) component. + Markdown-rich field descriptions aren't yet supported and will display as plain text. See the [Request path](#request-path) example below. diff --git a/fern/products/docs/pages/component-library/default-components/overview.mdx b/fern/products/docs/pages/component-library/default-components/overview.mdx index 344ab1dc8..0df2de7ce 100644 --- a/fern/products/docs/pages/component-library/default-components/overview.mdx +++ b/fern/products/docs/pages/component-library/default-components/overview.mdx @@ -3,7 +3,7 @@ title: 'Components overview' description: 'Built-in components for creating interactive documentation' --- -Fern includes 23 built-in components for creating interactive documentation. Select a component below to view usage examples and configuration options. +Fern includes 24 built-in components for creating interactive documentation. Select a component below to view usage examples and configuration options. Interactive request builder for testing API endpoints + + Display type definitions from your API Reference + ` 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. Field descriptions support markdown formatting. + +Similar to [``](/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 or webhooks won't be available. If multiple APIs have the same type name, the component returns the first match. + + +## Usage + +The component works with [API references already configured in your `docs.yml`](/learn/docs/api-references/generate-api-ref). This example displays the `AIChatConfig` type from the `docs-yml` API: + +
+
+ +
+
+ +```jsx Markdown + +``` + +## Properties + + + The name of the type to display. The component will search for this type across all endpoints in your API definition. + + + + Optional CSS class name for custom styling. + \ No newline at end of file diff --git a/fern/products/sdks/overview/php/changelog/2025-11-25.mdx b/fern/products/sdks/overview/php/changelog/2025-11-25.mdx index 3272545da..c0e2ae54d 100644 --- a/fern/products/sdks/overview/php/changelog/2025-11-25.mdx +++ b/fern/products/sdks/overview/php/changelog/2025-11-25.mdx @@ -3,7 +3,7 @@ ## 1.22.2 -**`(fix):`** Add missing