elasticsearch/docs/reference/query-languages/esql/_snippets/functions/parameters
Craig Taverner e6347b8ab0
[DOCS] Update ES|QL generated docs to consistently use the applies_to metadata (#128576)
- Add PREVIEW annotations to all preview functions
- Update docs generation logic to use annotations instead of preview boolean
* Changed stack: ga 9.1 to stack: coming in multiple places
  - Match.java: Updated the options parameter description
  - MultiMatch.java: Updated the options parameter description
  - ToLower.java: Reformatted parameter description and updated version annotation
  - ToUpper.java: Removed the appliesTo annotation entirely and reformatted parameter description

- updated applies_to annotations to specify both preview 9.0.0 and ga 9.1.0 lifecycle stages
- added version-specific documentation examples with applies_to markers for ga 9.1.0 features
- enhanced to_lower and to_upper functions to indicate support for multi-valued expressions in ga 9.1.0
- added version guards around function parameters and descriptions using applies_to syntax
- updated function parameter descriptions to indicate ga 9.1.0 availability for named parameters
- use detailedDescription + and fix match_phrase applies_to syntax
- strip inline applies_to from kibana docs
- update roundto, matchphrase lifecycles
-  fix match named params info
- various spatial functions are preview
- unsigned long is preview
- update qstr
- Update TO_LOWER/TO_UPPER parameter descriptions for clarity
- hide spatial functions per https://github.com/elastic/elasticsearch/pull/129839
- added `stack: ga 9.1.0` blocks to match_phrase.md and qstr.md examples
- simplified term.md version from `preview 9.0.0` to just `preview`
- added `applies_to = "stack: ga 9.1.0"` to matchphrase and querystring java annotations
- removed version `9.0.0` from term function annotation
- deleted unused `makeCallout()` and `appendLifeCycleAndVersion()` methods


Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Nik Everett <nik9000@gmail.com>
2025-06-23 20:07:41 +02:00
..
abs.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
acos.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
asin.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
atan.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
atan2.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
avg.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
bit_length.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
bucket.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
byte_length.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
case.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
categorize.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
cbrt.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
ceil.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
cidr_match.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
coalesce.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
concat.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
cos.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
cosh.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
count.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
count_distinct.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
date_diff.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
date_extract.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
date_format.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
date_parse.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
date_trunc.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
e.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
ends_with.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
exp.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
floor.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
from_base64.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
greatest.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
hash.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
hypot.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
ip_prefix.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
kql.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
least.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
left.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
length.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
locate.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
log.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
log10.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
ltrim.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
match.md [DOCS] Update ES|QL generated docs to consistently use the applies_to metadata (#128576) 2025-06-23 20:07:41 +02:00
match_phrase.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
max.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
md5.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
median.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
median_absolute_deviation.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
min.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
multi_match.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_append.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_avg.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_concat.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_count.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_dedupe.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_first.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_last.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_max.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_median.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_median_absolute_deviation.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_min.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_percentile.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_pseries_weighted_sum.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_slice.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_sort.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_sum.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
mv_zip.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
now.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
percentile.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
pi.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
pow.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
qstr.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
repeat.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
replace.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
reverse.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
right.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
round.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
round_to.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
rtrim.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sample.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
scalb.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sha1.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sha256.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
signum.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sin.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sinh.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
space.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
split.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sqrt.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_centroid_agg.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_contains.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_disjoint.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_distance.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_envelope.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_extent_agg.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohash.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohash_to_long.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohash_to_string.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohex.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohex_to_long.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geohex_to_string.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geotile.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geotile_to_long.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_geotile_to_string.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_intersects.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_within.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_x.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_xmax.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_xmin.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_y.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_ymax.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
st_ymin.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
starts_with.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
std_dev.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
substring.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
sum.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
tan.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
tanh.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
tau.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
term.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_aggregate_metric_double.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_base64.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_boolean.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_cartesianpoint.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_cartesianshape.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_date_nanos.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_dateperiod.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_datetime.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_degrees.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_double.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_geopoint.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_geoshape.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_integer.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_ip.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_long.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_lower.md [DOCS] Update ES|QL generated docs to consistently use the applies_to metadata (#128576) 2025-06-23 20:07:41 +02:00
to_radians.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_string.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_timeduration.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_unsigned_long.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
to_upper.md [DOCS] Update ES|QL generated docs to consistently use the applies_to metadata (#128576) 2025-06-23 20:07:41 +02:00
to_version.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
top.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
trim.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
values.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00
weighted_avg.md ESQL: Fix misspelling in generated docs (#129789) 2025-06-20 20:42:37 +01:00