From 52659c1dd7d2c50164379db5b0066afa35c3ac6d Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Tue, 19 Aug 2025 12:58:23 +0200 Subject: [PATCH] [API docs contrib guidance] Add clarification about availability since in ES spec Replicates https://github.com/elastic/elasticsearch-specification/pull/5149 h/t @pquentin --- extend/contribute/api-docs/organize-annotate.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/extend/contribute/api-docs/organize-annotate.md b/extend/contribute/api-docs/organize-annotate.md index d49113f2ea..a551c39601 100644 --- a/extend/contribute/api-docs/organize-annotate.md +++ b/extend/contribute/api-docs/organize-annotate.md @@ -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 @@ -449,4 +454,4 @@ The annotation system doesn't support "OR" relationships between privileges. Whe ::: ::: -:::: \ No newline at end of file +::::