***

title: Availability
headline: Availability (OpenAPI)
description: >-
Mark API endpoint availability in OpenAPI with `x-fern-availability`. Set
beta, deprecated, stable, etc. statuses for endpoints and sections.
-------------------------------------------------------------------

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](/learn/docs/configuration/site-level-settings).

## Endpoint

The options are:

* `beta`
* `generally-available`
* `deprecated`

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

```yaml title="x-fern-availability in openapi.yml" {4}
paths:
  /pet:
    post:
      x-fern-availability: deprecated
```

This renders as:

<Frame caption="A deprecated endpoint">
  ![Screenshot of API Reference endpoint with tag showing deprecated](https://fern-image-hosting.s3.amazonaws.com/fern/x-fern-availability-example.png)
</Frame>

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

```yaml title="docs.yml" {3, 6}
navigation: 
  - api: API Reference
    availability: generally-available
    layout: 
      - section: My Section
        availability: beta
        icon: flower
        contents: 
        # endpoints here
```