[DOCS] Fix ES|QL function and commands lists versioning metadata by leemthompo · Pull Request #143402 · elastic/elasticsearch

leemthompo · 2026-03-02T16:17:58Z

Makes sure the lists of functions and commands are up to date versioning and availability wise

tl:dr

Some lists were out of sync with the true version availability and lifecycles (preview or GA) of functions
NOTE: If something doesn't have a tag in a list, it's GA
- For example:
  - if there's no serverless tag on a list item it's GA on serverless
  - if there's no stack tag, the thing was GA already by 9.0

Methodology

Listed all files in _snippets/lists/
Read the @FunctionInfo / @FunctionAppliesTo annotation system in Java:
- FunctionInfo.java — annotation on function constructors; has preview = true and appliesTo[] fields
- FunctionAppliesTo.java — lifeCycle (PREVIEW, GA, DEVELOPMENT, COMING, ...) and version fields
Ran a broad grep across all x-pack/plugin/esql/src/main/java/ for preview = true and appliesTo to get a complete list of every function with non-default lifecycle metadata
Cross-checked each result against the corresponding entry in the list files
Applied corrections

Not covered / out of scope

NETWORK_DIRECTION: has preview = true in Java but is not listed in ip-functions.md (presumably intentionally unlisted)
TO_DATE_RANGE: has preview = true in Java but is not listed in type-conversion-functions.md
MULTI_MATCH: has COMING lifecycle in Java and is not listed in any list file
V_MAGNITUDE: DEVELOPMENT lifecycle in Java, correctly commented out (%) in the list
Individual function .md pages: function pages are generated (via DocsV3Support.java from @FunctionInfo annotations), so their applies_to front matter is kept in sync automatically and was not audited

Audit all _snippets/lists/ files against Java @FunctionAppliesTo annotations. Adds missing applies_to tags, corrects wrong versions, and applies cumulative preview→ga tags where functions graduated. Also adds missing applies_to front matter to time-series-aggregation-functions.md landing page.

github-actions · 2026-03-02T16:19:43Z

🔍 Preview links for changed docs

docs/reference/query-languages/esql/functions-operators/time-series-aggregation-functions.md

github-actions · 2026-03-02T16:19:44Z

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

Check out the cumulative docs guidelines
Reach out in the #docs Slack channel

leemthompo · 2026-03-02T16:53:22Z

docs/reference/query-languages/esql/_snippets/lists/dense-vector-functions.md

@@ -1,10 +1,10 @@
 * Dense vector functions


@carlosdelest can you confirm that these functions are properly tagged in the changes to this list?

Also want to make sure those features are GA on serverless before merging this PR. Thanks!

That looks correct @leemthompo ! Yep, those features are GA on serverless. 👍

Thanks for checking!

leemthompo · 2026-03-02T16:55:58Z

docs/reference/query-languages/esql/_snippets/lists/string-functions.md

+* [`URL_DECODE`](../../functions-operators/string-functions/url_decode.md) {applies_to}`stack: ga 9.2`
+* [`URL_ENCODE`](../../functions-operators/string-functions/url_encode.md) {applies_to}`stack: ga 9.2`
+* [`URL_ENCODE_COMPONENT`](../../functions-operators/string-functions/url_encode_component.md) {applies_to}`stack: ga 9.2`


@mouhc1ne can you confirm these are correct?

leemthompo · 2026-03-02T16:57:06Z

docs/reference/query-languages/esql/_snippets/lists/mv-functions.md

 * [`MV_AVG`](../../functions-operators/mv-functions/mv_avg.md)
 * [`MV_CONCAT`](../../functions-operators/mv-functions/mv_concat.md)
-* [`MV_CONTAINS`](../../functions-operators/mv-functions/mv_contains.md) {applies_to}`stack: preview` {applies_to}`serverless: preview`
+* [`MV_CONTAINS`](../../functions-operators/mv-functions/mv_contains.md) {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`


@mjmbischoff can you confirm this list is now correct?

elasticsearchmachine · 2026-03-02T17:20:06Z

Pinging @elastic/core-docs (Team:Docs)

kosabogi

LGTM

…cations * upstream/main: (56 commits) Mute org.elasticsearch.compute.lucene.read.ValueSourceReaderTypeConversionTests testLoadAll elastic#143471 [DOCS] Fix ES|QL function and commands lists versioning metadata (elastic#143402) Fix MMROperatorTests (elastic#143453) Fix CSV-escaped quotes in generated docs examples (elastic#143449) Fix SQL client parsing of array header values (elastic#143408) ESQL: Add extended distribution tests and fault injection for external sources (elastic#143420) ESQL: Fix datasource test failures on Windows and FIPS (elastic#143417) Add circuit breaker for query construction to prevent OOM from automaton-based queries (elastic#142150) Cleanup SpecIT logging configuration (elastic#143365) ESQL: Prune unused regex extract nodes in optimizer (elastic#140982) Ensure supported locale outside of Entitlements check (elastic#143405) feat(es|ql): add dense_vector support in coalesce (elastic#142974) [Test] Unmute SnapshotStressTestsIT (elastic#143359) Mute org.elasticsearch.xpack.esql.CsvIT test {csv-spec:lookup-join.LookupJoinWithCoalesceFilterOnRight} elastic#143443 Mute org.elasticsearch.xpack.esql.CsvIT test {csv-spec:lookup-join.MvJoinKeyOnTheLookupIndex} elastic#143442 ESQL: Fix CCS exchange sink cleanup (elastic#143325) Mute org.elasticsearch.xpack.esql.CsvIT test {csv-spec:lookup-join.MvJoinKeyOnTheLookupIndexAfterStats} elastic#143434 Mute org.elasticsearch.xpack.esql.CsvIT test {csv-spec:lookup-join.MvJoinKeyFromRow} elastic#143432 Mute org.elasticsearch.xpack.esql.qa.mixed.MixedClusterEsqlSpecIT test {csv-spec:k8s-timeseries.Datenanos_derivative_compared_to_rate} elastic#143431 Mute org.elasticsearch.multiproject.test.CoreWithMultipleProjectsClientYamlTestSuiteIT test {yaml=search.retrievers/result-diversification/10_mmr_result_diversification_retriever/Test MMR result diversification single index float type} elastic#143430 ...

…stic#143402) * Fix ES|QL function list versioning metadata Audit all _snippets/lists/ files against Java @FunctionAppliesTo annotations. Adds missing applies_to tags, corrects wrong versions, and applies cumulative preview→ga tags where functions graduated. Also adds missing applies_to front matter to time-series-aggregation-functions.md landing page. * update tags on commands lists

elasticsearchmachine added the v9.4.0 label Mar 2, 2026

leemthompo self-assigned this Mar 2, 2026

leemthompo commented Mar 2, 2026

View reviewed changes

leemthompo marked this pull request as ready for review March 2, 2026 17:19

leemthompo requested a review from a team as a code owner March 2, 2026 17:19

elasticsearchmachine added the needs:triage Requires assignment of a team area label label Mar 2, 2026

leemthompo added >docs General docs changes Team:Docs Meta label for docs team Feature:ES|QL and removed needs:triage Requires assignment of a team area label labels Mar 2, 2026

kosabogi approved these changes Mar 3, 2026

View reviewed changes

update tags on commands lists

22d7f88

leemthompo changed the title ~~[DOCS] Fix ES|QL function lists versioning metadata~~ [DOCS] Fix ES|QL function and commands lists versioning metadata Mar 3, 2026

leemthompo enabled auto-merge (squash) March 3, 2026 13:09

leemthompo merged commit c35d8f7 into elastic:main Mar 3, 2026
12 checks passed

This was referenced Mar 6, 2026

[ML] Wait for cluster state in test #143767

Merged

[Transform] Disable PIT for CPS #143876

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Fix ES|QL function and commands lists versioning metadata#143402

[DOCS] Fix ES|QL function and commands lists versioning metadata#143402
leemthompo merged 2 commits intoelastic:mainfrom
leemthompo:esql-cheat-sheet

leemthompo commented Mar 2, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 2, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 2, 2026

When to use applies_to tags:

What NOT to do:

Uh oh!

leemthompo Mar 2, 2026

Uh oh!

carlosdelest Mar 2, 2026

Uh oh!

leemthompo Mar 2, 2026

Uh oh!

leemthompo Mar 2, 2026

Uh oh!

elasticsearchmachine commented Mar 2, 2026

Uh oh!

kosabogi left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

leemthompo commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

tl:dr

Methodology

Not covered / out of scope

Uh oh!

github-actions bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Preview links for changed docs

Uh oh!

github-actions bot commented Mar 2, 2026

ℹ️ Important: Docs version tagging

When to use applies_to tags:

What NOT to do:

🤔 Need help?

Uh oh!

leemthompo Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

carlosdelest Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

leemthompo Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

leemthompo Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

elasticsearchmachine commented Mar 2, 2026

Uh oh!

kosabogi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

leemthompo commented Mar 2, 2026 •

edited

Loading

github-actions bot commented Mar 2, 2026 •

edited

Loading