Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 0 additions & 2 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: '<a href="/learn/api-definitions/ferndef/overview">Fern Definition</a> is no longer actively recommended for new projects but remains supported for existing users.'

- display-name: OpenAPI
href: /learn/api-definitions/openapi/overview
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/api-yml/environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: List environments like production, staging, and development.
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


You can specify the environments where your server is deployed.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/api-yml/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Specify error types and schemas
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


In order to generate SDKs idiomatically, Fern needs to know how to differentiate
between different errors when parsing an endpoint response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Specify global headers, path parameters or query parameters meant t
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


The `api.yml` configuration supports global configuration like headers and path parameters.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/api-yml/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: The api.yml file contains general API configuration when using the
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


A `fern/` folder has a special file called `api.yml`, which includes all the API-wide configuration.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ subtitle: Use audiences in your Fern Definition to segment your API for differen
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


<Markdown src="/snippets/team-or-pro-plan.mdx"/>

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Configure API authentication in Fern Definition. Set up bearer toke
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Configuring authentication schemes happens in the `api.yml` file. All Fern-generated SDKs support both direct configuration and environment variables for authentication credentials.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/availability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Add availability to Fern Definition API services, endpoints, types,
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


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).

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/depending-on-other-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ subtitle: Import API Definitions to generate unified SDKs
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Fern allows you to import other APIs into your API.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Organize related API endpoints into a service in Fern Definition an
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


In Fern, you organize related endpoints into a **Service**. This grouping
improves clarity and makes the generated SDKs more idiomatic.
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/endpoints/bytes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ subtitle: Use the `bytes` type to handle binary data in your API
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


<Note>
The `bytes` type allows you to handle binary data in both requests and responses.
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/endpoints/multipart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Document endpoints with the `multiform` content type.
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


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.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/endpoints/rest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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."
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Endpoints in Fern are defined underneath the `endpoints` key. Below is an example of defining
a single REST endpoint:
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/endpoints/sse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ subtitle: Use the `response-stream` key to model streaming endpoints
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


<Markdown src="/snippets/team-or-pro-plan.mdx"/>

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Add errors representing failed responses from API endpoints in Fern
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Errors represent failed (non-200) responses from endpoints.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ subtitle: Use Fern Definition to add API examples that are shown in comments of
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


You can add examples for types and endpoints. Examples are shown as
comments in your SDKs, in the request & response of your documentation,
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/export-openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Export Fern Definition to OpenAPI 3.1 format using the fern export
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


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).

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/imports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Use imports to reference API types and errors from other Fern Defin
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Imports allow you to reference types and errors from other files.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Fern Definition is a YAML format for API specifications. Define you
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


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.
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Fern Definition enables the reuse of API type and error names acros
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


## What is a package?

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Types describe the data model of your API. Fern has many built-in t
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


Types describe the data model of your API.

Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ max-toc-depth: 3
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


In Fern, you can specify webhooks in your API definition. The webhooks will be included
in both the generated SDKs and the API documentation.
Expand Down
2 changes: 2 additions & 0 deletions fern/products/api-def/ferndef/websockets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Learn how to define WebSockets in the Fern Definition
noindex: true
---

<Markdown src="/products/api-def/snippets/ferndef-deprecation.mdx" />


WebSockets enable a user to create a connection with a server, over which bidirectional communication can be sent.

Expand Down
3 changes: 3 additions & 0 deletions fern/products/api-def/snippets/ferndef-deprecation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'We'.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'We are'.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'we'.

</Note>
Loading