Availability

The x-fern-availability extension is used to mark the availability of an endpoint within your OpenAPI definition. The availability information propagates into the generated Fern Docs website as visual tags.

You can configure the availability of sections in your API reference documentation in your docs.yml file.

Endpoint

The options are:

• beta
• generally-available
• deprecated

The example below marks that the POST /pet endpoint is deprecated.

1
paths:
2
  /pet:
3
    post:
4
      x-fern-availability: deprecated

This renders as:

Section

You can set the availability for the entire API reference or for specific sections in your docs.yml configuration. Options are: stable, generally-available, in-development, pre-release, deprecated, or beta.

When you set the availability of a section, all of the endpoints in that section are automatically marked with that availability unless explicitly set otherwise.

1
navigation: 
2
  - api: API Reference
3
    availability: generally-available
4
    layout: 
5
      - section: My Section
6
        availability: beta
7
        icon: flower
8
        contents: 
9
        # endpoints here