Availability

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

The options are:

  • beta
  • generally-available
  • deprecated

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

x-fern-availability in openapi.yml
1paths:
2 /pet:
3 post:
4 x-fern-availability: deprecated

This renders as:

Screenshot of API Reference endpoint with tag showing deprecated

A deprecated endpoint