Skip to content

[API docs contrib guidance] Add clarification about @availability since in ES spec #2618

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
Aug 19, 2025
Merged

[API docs contrib guidance] Add clarification about @availability since in ES spec #2618

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
7 changes: 6 additions & 1 deletion extend/contribute/api-docs/organize-annotate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,11 @@ class FooRequest {

This example shows the "later addition" scenario where `laterAddition` was added after the initial API release, requiring a parameter-level availability annotation with a later version than the API-level availability.

:::::{important}
The `since` field is only available for `stack`. If the API is introduced in multiple major versions (eg: `8.19.0` and `9.1.0`), use the appropriate value in each branch.
:::::


**Deprecation notices** use the `@deprecated` annotation:

```ts
Expand Down Expand Up @@ -449,4 +454,4 @@ The annotation system doesn't support "OR" relationships between privileges. Whe
:::
:::

::::
::::
Loading