Skip to content

[Modeling guide] Add stability section to Availability tag #5760

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

Merged
merged 1 commit into from
Nov 27, 2025
Merged

[Modeling guide] Add stability section to Availability tag #5760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions docs/modeling-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,28 @@ export class Example {
}
```

### Stability property for `@availability`

The `stability` property can be added to an `@availability` annotation to indicate the maturity and expected backwards-compatibility of an API or property.

Syntax:
```ts
/** @availability stack since=<version> stability=<value> */
```

Values and meaning:
- `stable` => "Generally available"
- `beta` => "Beta"
- `experimental` => "Technical Preview"

Examples:
```ts
/**
* @rest_spec_name indices.create
* @availability stack since=1.0.0 stability=experimental
*/
```

#### description

You can (and should!) add a description for each type and property. For an in-depth explanation of how to write good descriptions, see [Documenting the API specification](doc-comments-guide.md).
Expand Down
Loading