Availability – Fern | Documentation

You can add availability to an endpoint, type, or property within your Fern Definition.

Availability can be:

in-development which means it is being worked on; will show a beta tag
pre-release which means it is available; will show a beta tag
deprecated which means it will be removed in the future; will show a deprecated tag
generally-available which means it is stable and available for use; will not show a tag

By default, all endpoints, types, and properties are generally-available.

Endpoint

imdb.yml

1 service:
2   auth: false
3   base-path: /movies
4   endpoints:
5     createMovie:
6 +     availability: deprecated
7       docs: Add a movie to the database
8       method: POST
9       path: /create-movie
10       request: CreateMovieRequest
11       response: MovieId

In Fern Docs, this will look like:

imdb.yml

1 service:
2   auth: false
3   base-path: /movies
4   endpoints:
5     createMovie:
6 +     availability: beta
7       docs: Add a movie to the database
8       method: POST
9       path: /create-movie
10       request: CreateMovieRequest
11       response: MovieId

In Fern Docs, this will look like:

Type

imdb.yml

1  Movie:
2     properties:
3       id: MovieId
4       title: string
5       rating:
6         type: double
7         docs: The rating scale out of ten stars
8       whereToWatch: 
9         type: WhereToWatch
10 +       availability: pre-release
11 
12   WhereToWatch: 
13     enum:
14       - theater
15       - netflix
16       - hulu
17       - prime_video

In Fern Docs, this will look like:

Property

imdb.yml

1   Movie:
2     properties:
3       id: MovieId
4       title: string
5       rating:
6 +       availability: deprecated
7         type: double
8         docs: The rating scale out of ten stars

In Fern Docs, this will look like:

1	service:
2	auth: false
3	base-path: /movies
4	endpoints:
5	createMovie:
6	+ availability: deprecated
7	docs: Add a movie to the database
8	method: POST
9	path: /create-movie
10	request: CreateMovieRequest
11	response: MovieId

1	Movie:
2	properties:
3	id: MovieId
4	title: string
5	rating:
6	type: double
7	docs: The rating scale out of ten stars
8	whereToWatch:
9	type: WhereToWatch
10	+ availability: pre-release
11
12	WhereToWatch:
13	enum:
14	- theater
15	- netflix
16	- hulu
17	- prime_video