From 4ac9b8d8d421e90d79c2f33beb71f2ed2928adad Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Fri, 15 May 2026 22:49:06 +0000 Subject: [PATCH 1/6] Remove announcement banner and add deprecation callout snippet to all Fern Definition pages --- fern/docs.yml | 2 -- fern/products/api-def/ferndef/api-yml/environments.mdx | 2 ++ fern/products/api-def/ferndef/api-yml/errors.mdx | 2 ++ fern/products/api-def/ferndef/api-yml/global-configuration.mdx | 2 ++ fern/products/api-def/ferndef/api-yml/overview.mdx | 2 ++ fern/products/api-def/ferndef/audiences.mdx | 2 ++ fern/products/api-def/ferndef/auth.mdx | 2 ++ fern/products/api-def/ferndef/availability.mdx | 2 ++ fern/products/api-def/ferndef/depending-on-other-apis.mdx | 2 ++ fern/products/api-def/ferndef/endpoints.mdx | 2 ++ fern/products/api-def/ferndef/endpoints/bytes.mdx | 2 ++ fern/products/api-def/ferndef/endpoints/multipart.mdx | 2 ++ fern/products/api-def/ferndef/endpoints/rest.mdx | 2 ++ fern/products/api-def/ferndef/endpoints/sse.mdx | 2 ++ fern/products/api-def/ferndef/errors.mdx | 2 ++ fern/products/api-def/ferndef/examples.mdx | 2 ++ fern/products/api-def/ferndef/export-openapi.mdx | 2 ++ fern/products/api-def/ferndef/imports.mdx | 2 ++ fern/products/api-def/ferndef/overview.mdx | 2 ++ fern/products/api-def/ferndef/packages.mdx | 2 ++ fern/products/api-def/ferndef/types.mdx | 2 ++ fern/products/api-def/ferndef/webhooks.mdx | 2 ++ fern/products/api-def/ferndef/websockets.mdx | 2 ++ fern/products/api-def/snippets/ferndef-deprecation.mdx | 3 +++ 24 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 fern/products/api-def/snippets/ferndef-deprecation.mdx diff --git a/fern/docs.yml b/fern/docs.yml index 8f1c5360e..1ad76ba12 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -78,8 +78,6 @@ products: image: ./images/product-switcher/openapi-definition-light.png slug: api-definitions subtitle: Import and configure your API specifications - announcement: - message: 'Fern Definition is no longer actively recommended for new projects but remains supported for existing users.' - display-name: OpenAPI href: /learn/api-definitions/openapi/overview diff --git a/fern/products/api-def/ferndef/api-yml/environments.mdx b/fern/products/api-def/ferndef/api-yml/environments.mdx index 45906c6d0..9f740ef09 100644 --- a/fern/products/api-def/ferndef/api-yml/environments.mdx +++ b/fern/products/api-def/ferndef/api-yml/environments.mdx @@ -4,6 +4,8 @@ description: List environments like production, staging, and development. noindex: true --- + + You can specify the environments where your server is deployed. diff --git a/fern/products/api-def/ferndef/api-yml/errors.mdx b/fern/products/api-def/ferndef/api-yml/errors.mdx index 87f76cb9c..435e9f2cf 100644 --- a/fern/products/api-def/ferndef/api-yml/errors.mdx +++ b/fern/products/api-def/ferndef/api-yml/errors.mdx @@ -4,6 +4,8 @@ description: Specify error types and schemas noindex: true --- + + In order to generate SDKs idiomatically, Fern needs to know how to differentiate between different errors when parsing an endpoint response. diff --git a/fern/products/api-def/ferndef/api-yml/global-configuration.mdx b/fern/products/api-def/ferndef/api-yml/global-configuration.mdx index 142b5acf7..c2283e97b 100644 --- a/fern/products/api-def/ferndef/api-yml/global-configuration.mdx +++ b/fern/products/api-def/ferndef/api-yml/global-configuration.mdx @@ -4,6 +4,8 @@ description: Specify global headers, path parameters or query parameters meant t noindex: true --- + + The `api.yml` configuration supports global configuration like headers and path parameters. diff --git a/fern/products/api-def/ferndef/api-yml/overview.mdx b/fern/products/api-def/ferndef/api-yml/overview.mdx index 5e06a27bd..3526aa4d5 100644 --- a/fern/products/api-def/ferndef/api-yml/overview.mdx +++ b/fern/products/api-def/ferndef/api-yml/overview.mdx @@ -4,6 +4,8 @@ description: The api.yml file contains general API configuration when using the noindex: true --- + + A `fern/` folder has a special file called `api.yml`, which includes all the API-wide configuration. diff --git a/fern/products/api-def/ferndef/audiences.mdx b/fern/products/api-def/ferndef/audiences.mdx index be0bb1b1e..c0d750036 100644 --- a/fern/products/api-def/ferndef/audiences.mdx +++ b/fern/products/api-def/ferndef/audiences.mdx @@ -4,6 +4,8 @@ subtitle: Use audiences in your Fern Definition to segment your API for differen noindex: true --- + + diff --git a/fern/products/api-def/ferndef/auth.mdx b/fern/products/api-def/ferndef/auth.mdx index 139484503..2913cae03 100644 --- a/fern/products/api-def/ferndef/auth.mdx +++ b/fern/products/api-def/ferndef/auth.mdx @@ -4,6 +4,8 @@ description: Configure API authentication in Fern Definition. Set up bearer toke noindex: true --- + + Configuring authentication schemes happens in the `api.yml` file. All Fern-generated SDKs support both direct configuration and environment variables for authentication credentials. diff --git a/fern/products/api-def/ferndef/availability.mdx b/fern/products/api-def/ferndef/availability.mdx index 66928c91f..9ed3791b3 100644 --- a/fern/products/api-def/ferndef/availability.mdx +++ b/fern/products/api-def/ferndef/availability.mdx @@ -4,6 +4,8 @@ description: Add availability to Fern Definition API services, endpoints, types, noindex: true --- + + You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API Reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings). diff --git a/fern/products/api-def/ferndef/depending-on-other-apis.mdx b/fern/products/api-def/ferndef/depending-on-other-apis.mdx index 03baf715b..c92a2239b 100644 --- a/fern/products/api-def/ferndef/depending-on-other-apis.mdx +++ b/fern/products/api-def/ferndef/depending-on-other-apis.mdx @@ -4,6 +4,8 @@ subtitle: Import API Definitions to generate unified SDKs noindex: true --- + + Fern allows you to import other APIs into your API. diff --git a/fern/products/api-def/ferndef/endpoints.mdx b/fern/products/api-def/ferndef/endpoints.mdx index e6cc9bd45..9a60884bb 100644 --- a/fern/products/api-def/ferndef/endpoints.mdx +++ b/fern/products/api-def/ferndef/endpoints.mdx @@ -4,6 +4,8 @@ description: Organize related API endpoints into a service in Fern Definition an noindex: true --- + + In Fern, you organize related endpoints into a **Service**. This grouping improves clarity and makes the generated SDKs more idiomatic. diff --git a/fern/products/api-def/ferndef/endpoints/bytes.mdx b/fern/products/api-def/ferndef/endpoints/bytes.mdx index 3c09c3ca9..2c9763656 100644 --- a/fern/products/api-def/ferndef/endpoints/bytes.mdx +++ b/fern/products/api-def/ferndef/endpoints/bytes.mdx @@ -4,6 +4,8 @@ subtitle: Use the `bytes` type to handle binary data in your API noindex: true --- + + The `bytes` type allows you to handle binary data in both requests and responses. diff --git a/fern/products/api-def/ferndef/endpoints/multipart.mdx b/fern/products/api-def/ferndef/endpoints/multipart.mdx index 0ea3079de..bc7f9689a 100644 --- a/fern/products/api-def/ferndef/endpoints/multipart.mdx +++ b/fern/products/api-def/ferndef/endpoints/multipart.mdx @@ -4,6 +4,8 @@ description: Document endpoints with the `multiform` content type. noindex: true --- + + Endpoints in Fern are defined underneath the `endpoints` key. If your endpoint request includes file uploads, you can use the `file` type to indicate the request is of a `multiform` content type. The example below demonstrates an endpoint which includes a file in the request body. diff --git a/fern/products/api-def/ferndef/endpoints/rest.mdx b/fern/products/api-def/ferndef/endpoints/rest.mdx index 511cc560e..5007b30d9 100644 --- a/fern/products/api-def/ferndef/endpoints/rest.mdx +++ b/fern/products/api-def/ferndef/endpoints/rest.mdx @@ -4,6 +4,8 @@ noindex: true description: "Define HTTP JSON endpoints in the Fern Definition under the endpoints key, including path, method, request bodies, responses, and examples." --- + + Endpoints in Fern are defined underneath the `endpoints` key. Below is an example of defining a single REST endpoint: diff --git a/fern/products/api-def/ferndef/endpoints/sse.mdx b/fern/products/api-def/ferndef/endpoints/sse.mdx index 75e30bf0b..df2304535 100644 --- a/fern/products/api-def/ferndef/endpoints/sse.mdx +++ b/fern/products/api-def/ferndef/endpoints/sse.mdx @@ -4,6 +4,8 @@ subtitle: Use the `response-stream` key to model streaming endpoints noindex: true --- + + diff --git a/fern/products/api-def/ferndef/errors.mdx b/fern/products/api-def/ferndef/errors.mdx index cf8d2a9d8..7b4035878 100644 --- a/fern/products/api-def/ferndef/errors.mdx +++ b/fern/products/api-def/ferndef/errors.mdx @@ -4,6 +4,8 @@ description: Add errors representing failed responses from API endpoints in Fern noindex: true --- + + Errors represent failed (non-200) responses from endpoints. diff --git a/fern/products/api-def/ferndef/examples.mdx b/fern/products/api-def/ferndef/examples.mdx index cc581dd58..b4404576c 100644 --- a/fern/products/api-def/ferndef/examples.mdx +++ b/fern/products/api-def/ferndef/examples.mdx @@ -4,6 +4,8 @@ subtitle: Use Fern Definition to add API examples that are shown in comments of noindex: true --- + + You can add examples for types and endpoints. Examples are shown as comments in your SDKs, in the request & response of your documentation, diff --git a/fern/products/api-def/ferndef/export-openapi.mdx b/fern/products/api-def/ferndef/export-openapi.mdx index f60ac136a..3f0b2f6c4 100644 --- a/fern/products/api-def/ferndef/export-openapi.mdx +++ b/fern/products/api-def/ferndef/export-openapi.mdx @@ -4,6 +4,8 @@ description: Export Fern Definition to OpenAPI 3.1 format using the fern export noindex: true --- + + To prevent lock-in to the Fern Definition format, you can export your API definition to OpenAPI 3.1 at any time [using the `fern export` command](/cli-api-reference/cli-reference/commands#fern-export). diff --git a/fern/products/api-def/ferndef/imports.mdx b/fern/products/api-def/ferndef/imports.mdx index b7a114adf..5dde1dfe6 100644 --- a/fern/products/api-def/ferndef/imports.mdx +++ b/fern/products/api-def/ferndef/imports.mdx @@ -4,6 +4,8 @@ description: Use imports to reference API types and errors from other Fern Defin noindex: true --- + + Imports allow you to reference types and errors from other files. diff --git a/fern/products/api-def/ferndef/overview.mdx b/fern/products/api-def/ferndef/overview.mdx index 15dbbdef9..f9eaef9c4 100644 --- a/fern/products/api-def/ferndef/overview.mdx +++ b/fern/products/api-def/ferndef/overview.mdx @@ -4,6 +4,8 @@ description: Fern Definition is a YAML format for API specifications. Define you noindex: true --- + + A Fern Definition is a set of YAML files that are the single source of truth for your API. You check your Fern Definition into your repo, inside of which describes your API requests, responses, models, paths, methods, errors, and authentication scheme. diff --git a/fern/products/api-def/ferndef/packages.mdx b/fern/products/api-def/ferndef/packages.mdx index fd3323875..fd4cf4c93 100644 --- a/fern/products/api-def/ferndef/packages.mdx +++ b/fern/products/api-def/ferndef/packages.mdx @@ -4,6 +4,8 @@ description: Fern Definition enables the reuse of API type and error names acros noindex: true --- + + ## What is a package? diff --git a/fern/products/api-def/ferndef/types.mdx b/fern/products/api-def/ferndef/types.mdx index 75ae334c5..fdf540251 100644 --- a/fern/products/api-def/ferndef/types.mdx +++ b/fern/products/api-def/ferndef/types.mdx @@ -4,6 +4,8 @@ description: Types describe the data model of your API. Fern has many built-in t noindex: true --- + + Types describe the data model of your API. diff --git a/fern/products/api-def/ferndef/webhooks.mdx b/fern/products/api-def/ferndef/webhooks.mdx index c7e9a6502..9672aee5c 100644 --- a/fern/products/api-def/ferndef/webhooks.mdx +++ b/fern/products/api-def/ferndef/webhooks.mdx @@ -5,6 +5,8 @@ max-toc-depth: 3 noindex: true --- + + In Fern, you can specify webhooks in your API definition. The webhooks will be included in both the generated SDKs and the API documentation. diff --git a/fern/products/api-def/ferndef/websockets.mdx b/fern/products/api-def/ferndef/websockets.mdx index fc359b949..67af3d6fe 100644 --- a/fern/products/api-def/ferndef/websockets.mdx +++ b/fern/products/api-def/ferndef/websockets.mdx @@ -4,6 +4,8 @@ description: Learn how to define WebSockets in the Fern Definition noindex: true --- + + WebSockets enable a user to create a connection with a server, over which bidirectional communication can be sent. diff --git a/fern/products/api-def/snippets/ferndef-deprecation.mdx b/fern/products/api-def/snippets/ferndef-deprecation.mdx new file mode 100644 index 000000000..1c555f470 --- /dev/null +++ b/fern/products/api-def/snippets/ferndef-deprecation.mdx @@ -0,0 +1,3 @@ + +Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead. + From 82730470566f550fcbd299e7453bf7cd8a962173 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Fri, 15 May 2026 22:51:32 +0000 Subject: [PATCH 2/6] Rename snippet to ferndef-support and update callout to mention continued support for existing users --- fern/products/api-def/ferndef/api-yml/environments.mdx | 2 +- fern/products/api-def/ferndef/api-yml/errors.mdx | 2 +- fern/products/api-def/ferndef/api-yml/global-configuration.mdx | 2 +- fern/products/api-def/ferndef/api-yml/overview.mdx | 2 +- fern/products/api-def/ferndef/audiences.mdx | 2 +- fern/products/api-def/ferndef/auth.mdx | 2 +- fern/products/api-def/ferndef/availability.mdx | 2 +- fern/products/api-def/ferndef/depending-on-other-apis.mdx | 2 +- fern/products/api-def/ferndef/endpoints.mdx | 2 +- fern/products/api-def/ferndef/endpoints/bytes.mdx | 2 +- fern/products/api-def/ferndef/endpoints/multipart.mdx | 2 +- fern/products/api-def/ferndef/endpoints/rest.mdx | 2 +- fern/products/api-def/ferndef/endpoints/sse.mdx | 2 +- fern/products/api-def/ferndef/errors.mdx | 2 +- fern/products/api-def/ferndef/examples.mdx | 2 +- fern/products/api-def/ferndef/export-openapi.mdx | 2 +- fern/products/api-def/ferndef/imports.mdx | 2 +- fern/products/api-def/ferndef/overview.mdx | 2 +- fern/products/api-def/ferndef/packages.mdx | 2 +- fern/products/api-def/ferndef/types.mdx | 2 +- fern/products/api-def/ferndef/webhooks.mdx | 2 +- fern/products/api-def/ferndef/websockets.mdx | 2 +- fern/products/api-def/snippets/ferndef-deprecation.mdx | 3 --- fern/products/api-def/snippets/ferndef-support.mdx | 3 +++ 24 files changed, 25 insertions(+), 25 deletions(-) delete mode 100644 fern/products/api-def/snippets/ferndef-deprecation.mdx create mode 100644 fern/products/api-def/snippets/ferndef-support.mdx diff --git a/fern/products/api-def/ferndef/api-yml/environments.mdx b/fern/products/api-def/ferndef/api-yml/environments.mdx index 9f740ef09..0d993f383 100644 --- a/fern/products/api-def/ferndef/api-yml/environments.mdx +++ b/fern/products/api-def/ferndef/api-yml/environments.mdx @@ -4,7 +4,7 @@ description: List environments like production, staging, and development. noindex: true --- - + You can specify the environments where your server is deployed. diff --git a/fern/products/api-def/ferndef/api-yml/errors.mdx b/fern/products/api-def/ferndef/api-yml/errors.mdx index 435e9f2cf..7741c1b07 100644 --- a/fern/products/api-def/ferndef/api-yml/errors.mdx +++ b/fern/products/api-def/ferndef/api-yml/errors.mdx @@ -4,7 +4,7 @@ description: Specify error types and schemas noindex: true --- - + In order to generate SDKs idiomatically, Fern needs to know how to differentiate diff --git a/fern/products/api-def/ferndef/api-yml/global-configuration.mdx b/fern/products/api-def/ferndef/api-yml/global-configuration.mdx index c2283e97b..7d1c1bbef 100644 --- a/fern/products/api-def/ferndef/api-yml/global-configuration.mdx +++ b/fern/products/api-def/ferndef/api-yml/global-configuration.mdx @@ -4,7 +4,7 @@ description: Specify global headers, path parameters or query parameters meant t noindex: true --- - + The `api.yml` configuration supports global configuration like headers and path parameters. diff --git a/fern/products/api-def/ferndef/api-yml/overview.mdx b/fern/products/api-def/ferndef/api-yml/overview.mdx index 3526aa4d5..78ec4e74f 100644 --- a/fern/products/api-def/ferndef/api-yml/overview.mdx +++ b/fern/products/api-def/ferndef/api-yml/overview.mdx @@ -4,7 +4,7 @@ description: The api.yml file contains general API configuration when using the noindex: true --- - + A `fern/` folder has a special file called `api.yml`, which includes all the API-wide configuration. diff --git a/fern/products/api-def/ferndef/audiences.mdx b/fern/products/api-def/ferndef/audiences.mdx index c0d750036..f331ff1f0 100644 --- a/fern/products/api-def/ferndef/audiences.mdx +++ b/fern/products/api-def/ferndef/audiences.mdx @@ -4,7 +4,7 @@ subtitle: Use audiences in your Fern Definition to segment your API for differen noindex: true --- - + diff --git a/fern/products/api-def/ferndef/auth.mdx b/fern/products/api-def/ferndef/auth.mdx index 2913cae03..5b2eafee4 100644 --- a/fern/products/api-def/ferndef/auth.mdx +++ b/fern/products/api-def/ferndef/auth.mdx @@ -4,7 +4,7 @@ description: Configure API authentication in Fern Definition. Set up bearer toke noindex: true --- - + Configuring authentication schemes happens in the `api.yml` file. All Fern-generated SDKs support both direct configuration and environment variables for authentication credentials. diff --git a/fern/products/api-def/ferndef/availability.mdx b/fern/products/api-def/ferndef/availability.mdx index 9ed3791b3..35c1256a5 100644 --- a/fern/products/api-def/ferndef/availability.mdx +++ b/fern/products/api-def/ferndef/availability.mdx @@ -4,7 +4,7 @@ description: Add availability to Fern Definition API services, endpoints, types, noindex: true --- - + You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API Reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings). diff --git a/fern/products/api-def/ferndef/depending-on-other-apis.mdx b/fern/products/api-def/ferndef/depending-on-other-apis.mdx index c92a2239b..cde492345 100644 --- a/fern/products/api-def/ferndef/depending-on-other-apis.mdx +++ b/fern/products/api-def/ferndef/depending-on-other-apis.mdx @@ -4,7 +4,7 @@ subtitle: Import API Definitions to generate unified SDKs noindex: true --- - + Fern allows you to import other APIs into your API. diff --git a/fern/products/api-def/ferndef/endpoints.mdx b/fern/products/api-def/ferndef/endpoints.mdx index 9a60884bb..b86a6bf88 100644 --- a/fern/products/api-def/ferndef/endpoints.mdx +++ b/fern/products/api-def/ferndef/endpoints.mdx @@ -4,7 +4,7 @@ description: Organize related API endpoints into a service in Fern Definition an noindex: true --- - + In Fern, you organize related endpoints into a **Service**. This grouping diff --git a/fern/products/api-def/ferndef/endpoints/bytes.mdx b/fern/products/api-def/ferndef/endpoints/bytes.mdx index 2c9763656..09d9d1b4b 100644 --- a/fern/products/api-def/ferndef/endpoints/bytes.mdx +++ b/fern/products/api-def/ferndef/endpoints/bytes.mdx @@ -4,7 +4,7 @@ subtitle: Use the `bytes` type to handle binary data in your API noindex: true --- - + diff --git a/fern/products/api-def/ferndef/endpoints/multipart.mdx b/fern/products/api-def/ferndef/endpoints/multipart.mdx index bc7f9689a..41339bd45 100644 --- a/fern/products/api-def/ferndef/endpoints/multipart.mdx +++ b/fern/products/api-def/ferndef/endpoints/multipart.mdx @@ -4,7 +4,7 @@ description: Document endpoints with the `multiform` content type. noindex: true --- - + Endpoints in Fern are defined underneath the `endpoints` key. If your endpoint request includes file uploads, you can use the `file` type to indicate the request is of a `multiform` content type. The example below demonstrates an endpoint which includes a file in the request body. diff --git a/fern/products/api-def/ferndef/endpoints/rest.mdx b/fern/products/api-def/ferndef/endpoints/rest.mdx index 5007b30d9..bf4ab1db3 100644 --- a/fern/products/api-def/ferndef/endpoints/rest.mdx +++ b/fern/products/api-def/ferndef/endpoints/rest.mdx @@ -4,7 +4,7 @@ noindex: true description: "Define HTTP JSON endpoints in the Fern Definition under the endpoints key, including path, method, request bodies, responses, and examples." --- - + Endpoints in Fern are defined underneath the `endpoints` key. Below is an example of defining diff --git a/fern/products/api-def/ferndef/endpoints/sse.mdx b/fern/products/api-def/ferndef/endpoints/sse.mdx index df2304535..a51d15746 100644 --- a/fern/products/api-def/ferndef/endpoints/sse.mdx +++ b/fern/products/api-def/ferndef/endpoints/sse.mdx @@ -4,7 +4,7 @@ subtitle: Use the `response-stream` key to model streaming endpoints noindex: true --- - + diff --git a/fern/products/api-def/ferndef/errors.mdx b/fern/products/api-def/ferndef/errors.mdx index 7b4035878..a9f11345e 100644 --- a/fern/products/api-def/ferndef/errors.mdx +++ b/fern/products/api-def/ferndef/errors.mdx @@ -4,7 +4,7 @@ description: Add errors representing failed responses from API endpoints in Fern noindex: true --- - + Errors represent failed (non-200) responses from endpoints. diff --git a/fern/products/api-def/ferndef/examples.mdx b/fern/products/api-def/ferndef/examples.mdx index b4404576c..fe8dca6b7 100644 --- a/fern/products/api-def/ferndef/examples.mdx +++ b/fern/products/api-def/ferndef/examples.mdx @@ -4,7 +4,7 @@ subtitle: Use Fern Definition to add API examples that are shown in comments of noindex: true --- - + You can add examples for types and endpoints. Examples are shown as diff --git a/fern/products/api-def/ferndef/export-openapi.mdx b/fern/products/api-def/ferndef/export-openapi.mdx index 3f0b2f6c4..8adae6c3d 100644 --- a/fern/products/api-def/ferndef/export-openapi.mdx +++ b/fern/products/api-def/ferndef/export-openapi.mdx @@ -4,7 +4,7 @@ description: Export Fern Definition to OpenAPI 3.1 format using the fern export noindex: true --- - + To prevent lock-in to the Fern Definition format, you can export your API definition to OpenAPI 3.1 at any time [using the `fern export` command](/cli-api-reference/cli-reference/commands#fern-export). diff --git a/fern/products/api-def/ferndef/imports.mdx b/fern/products/api-def/ferndef/imports.mdx index 5dde1dfe6..56792a3df 100644 --- a/fern/products/api-def/ferndef/imports.mdx +++ b/fern/products/api-def/ferndef/imports.mdx @@ -4,7 +4,7 @@ description: Use imports to reference API types and errors from other Fern Defin noindex: true --- - + Imports allow you to reference types and errors from other files. diff --git a/fern/products/api-def/ferndef/overview.mdx b/fern/products/api-def/ferndef/overview.mdx index f9eaef9c4..20c34a5b5 100644 --- a/fern/products/api-def/ferndef/overview.mdx +++ b/fern/products/api-def/ferndef/overview.mdx @@ -4,7 +4,7 @@ description: Fern Definition is a YAML format for API specifications. Define you noindex: true --- - + A Fern Definition is a set of YAML files that are the single source of truth for your API. You check your Fern Definition into your repo, diff --git a/fern/products/api-def/ferndef/packages.mdx b/fern/products/api-def/ferndef/packages.mdx index fd4cf4c93..3eb7dea50 100644 --- a/fern/products/api-def/ferndef/packages.mdx +++ b/fern/products/api-def/ferndef/packages.mdx @@ -4,7 +4,7 @@ description: Fern Definition enables the reuse of API type and error names acros noindex: true --- - + ## What is a package? diff --git a/fern/products/api-def/ferndef/types.mdx b/fern/products/api-def/ferndef/types.mdx index fdf540251..c64d060ae 100644 --- a/fern/products/api-def/ferndef/types.mdx +++ b/fern/products/api-def/ferndef/types.mdx @@ -4,7 +4,7 @@ description: Types describe the data model of your API. Fern has many built-in t noindex: true --- - + Types describe the data model of your API. diff --git a/fern/products/api-def/ferndef/webhooks.mdx b/fern/products/api-def/ferndef/webhooks.mdx index 9672aee5c..767737349 100644 --- a/fern/products/api-def/ferndef/webhooks.mdx +++ b/fern/products/api-def/ferndef/webhooks.mdx @@ -5,7 +5,7 @@ max-toc-depth: 3 noindex: true --- - + In Fern, you can specify webhooks in your API definition. The webhooks will be included diff --git a/fern/products/api-def/ferndef/websockets.mdx b/fern/products/api-def/ferndef/websockets.mdx index 67af3d6fe..65dccff78 100644 --- a/fern/products/api-def/ferndef/websockets.mdx +++ b/fern/products/api-def/ferndef/websockets.mdx @@ -4,7 +4,7 @@ description: Learn how to define WebSockets in the Fern Definition noindex: true --- - + WebSockets enable a user to create a connection with a server, over which bidirectional communication can be sent. diff --git a/fern/products/api-def/snippets/ferndef-deprecation.mdx b/fern/products/api-def/snippets/ferndef-deprecation.mdx deleted file mode 100644 index 1c555f470..000000000 --- a/fern/products/api-def/snippets/ferndef-deprecation.mdx +++ /dev/null @@ -1,3 +0,0 @@ - -Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead. - diff --git a/fern/products/api-def/snippets/ferndef-support.mdx b/fern/products/api-def/snippets/ferndef-support.mdx new file mode 100644 index 000000000..f940a3333 --- /dev/null +++ b/fern/products/api-def/snippets/ferndef-support.mdx @@ -0,0 +1,3 @@ + +Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead. + From 06679d2fb800857156f1d7c06e443d8a5093b585 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 15 May 2026 18:54:03 -0400 Subject: [PATCH 3/6] refine wording --- fern/products/api-def/snippets/ferndef-support.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/fern/products/api-def/snippets/ferndef-support.mdx b/fern/products/api-def/snippets/ferndef-support.mdx index f940a3333..6b3408420 100644 --- a/fern/products/api-def/snippets/ferndef-support.mdx +++ b/fern/products/api-def/snippets/ferndef-support.mdx @@ -1,3 +1,3 @@ - -Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead. - + +Fern Definition is not recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users. + From 924462dca36939589b879ded91ac14816636d101 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 15 May 2026 18:55:07 -0400 Subject: [PATCH 4/6] remove title --- fern/products/api-def/snippets/ferndef-support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/api-def/snippets/ferndef-support.mdx b/fern/products/api-def/snippets/ferndef-support.mdx index 6b3408420..a388d08de 100644 --- a/fern/products/api-def/snippets/ferndef-support.mdx +++ b/fern/products/api-def/snippets/ferndef-support.mdx @@ -1,3 +1,3 @@ - + Fern Definition is not recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users. From 9950b766b885b980c3755ee9b425fade54cd3c1c Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 18 May 2026 12:32:48 -0400 Subject: [PATCH 5/6] fix error --- fern/products/api-def/snippets/ferndef-support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/api-def/snippets/ferndef-support.mdx b/fern/products/api-def/snippets/ferndef-support.mdx index a388d08de..6db30805c 100644 --- a/fern/products/api-def/snippets/ferndef-support.mdx +++ b/fern/products/api-def/snippets/ferndef-support.mdx @@ -1,3 +1,3 @@ Fern Definition is not recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users. - + From 5986273958993a3ecf3681cbe567c9e1f0b8d574 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 18 May 2026 12:33:32 -0400 Subject: [PATCH 6/6] fix vale --- fern/products/api-def/snippets/ferndef-support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/api-def/snippets/ferndef-support.mdx b/fern/products/api-def/snippets/ferndef-support.mdx index 6db30805c..feec64b30 100644 --- a/fern/products/api-def/snippets/ferndef-support.mdx +++ b/fern/products/api-def/snippets/ferndef-support.mdx @@ -1,3 +1,3 @@ -Fern Definition is not recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users. +Fern Definition isn't recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users.