Skip to content

docs: add alpha, beta, preview, legacy availability values #5130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Swimburger wants to merge 3 commits into
base: main
Choose a base branch
from
+19 −7
Open

docs: add alpha, beta, preview, legacy availability values #5130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a26fba8
docs: add alpha, preview, legacy availability values
Swimburger Apr 23, 2026
9ea15dc
list --> markdown table
devalog Apr 24, 2026
12198e4
docs: add beta to fern definition availability table
Swimburger Apr 25, 2026
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
15 changes: 11 additions & 4 deletions fern/products/api-def/ferndef/availability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@ You can add `availability` to an endpoint, type, or property within your Fern De
## Endpoints, types, and properties

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 show a `GA` tag

| Value | Description | Tag |
| --- | --- | --- |
| `alpha` | Early experimental release | `Alpha` |
| `in-development` | Being worked on | `Beta` |
| `beta` | Available but may change | `Beta` |
| `pre-release` | Available | `Beta` |
| `preview` | Feature-complete but subject to change | `Preview` |
| `generally-available` | Stable and available for use | `GA` |
| `deprecated` | Will be removed in the future | `Deprecated` |
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot Apr 24, 2026

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.Current] Avoid time-relative terms like 'in the future' that become outdated

| `legacy` | Superseded but still supported | `Legacy` |
Comment on lines +13 to +22
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot Apr 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

🟡 Shared availability snippet not updated with new values, creating within-page inconsistency

Both changed pages include <Markdown src="/products/api-def/snippets/availability.mdx" /> at the bottom (lines fern/products/api-def/ferndef/availability.mdx:109 and fern/products/api-def/openapi/extensions/availability.mdx:42). The snippet at fern/products/api-def/snippets/availability.mdx:1 still lists only the old options: stable, generally-available, in-development, pre-release, deprecated, or beta. The new availability values alpha, preview, and legacy are added to the tables at the top of both pages but are absent from the included snippet. A user reading either page would see the new values documented in the "Endpoints" section, then scroll to the "Sections" section and find a different, incomplete set of options. This also violates the AGENTS.md rule: "Before creating new content, search the repo for existing pages that already cover the topic. Prefer updating over duplicating."

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


### Endpoint

Expand Down
11 changes: 8 additions & 3 deletions fern/products/api-def/openapi/extensions/availability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,14 @@ You can configure the `availability` of sections in your API Reference documenta

The options are:

- `beta`
- `generally-available`
- `deprecated`
| Value | Description | Tag |
| --- | --- | --- |
| `alpha` | Early experimental stage | `Alpha` |
| `beta` | Stable enough for early adopters | `Beta` |
| `preview` | Feature-complete but subject to change | `Preview` |
| `generally-available` | Stable and ready for production | `GA` |
| `deprecated` | No longer recommended for new use | `Deprecated` |
| `legacy` | Superseded but still supported | `Legacy` |

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

Expand Down
Loading