Skip to content

Commit 0ed04af

Browse files
Add stability section to Availability tag (#5760) (#5761)
(cherry picked from commit f6ff5b8) Co-authored-by: Laurent Saint-Félix <[email protected]>
1 parent 10957ca commit 0ed04af

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/modeling-guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,28 @@ export class Example {
562562
}
563563
```
564564
565+
### Stability property for `@availability`
566+
567+
The `stability` property can be added to an `@availability` annotation to indicate the maturity and expected backwards-compatibility of an API or property.
568+
569+
Syntax:
570+
```ts
571+
/** @availability stack since=<version> stability=<value> */
572+
```
573+
574+
Values and meaning:
575+
- `stable` => "Generally available"
576+
- `beta` => "Beta"
577+
- `experimental` => "Technical Preview"
578+
579+
Examples:
580+
```ts
581+
/**
582+
* @rest_spec_name indices.create
583+
* @availability stack since=1.0.0 stability=experimental
584+
*/
585+
```
586+
565587
#### description
566588
567589
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).

0 commit comments

Comments
 (0)