Skip to content

Commit b7e0c32

Browse files
committed
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
1 parent ca242bd commit b7e0c32

File tree

5 files changed

+27
-19
lines changed

5 files changed

+27
-19
lines changed

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ public Match(
256256
description = "Indicates whether all documents or none are returned if the analyzer removes all tokens, such as "
257257
+ "when using a stop filter. Defaults to none."
258258
) },
259-
description = "(Optional) Match additional options as <<esql-function-named-params,function named parameters>>.{applies_to}`stack: ga 9.1`"
259+
description = "(Optional) Match additional options as <<esql-function-named-params,function named parameters>>.{applies_to}`stack: coming`"
260260
+ " See <<query-dsl-match-query,match query>> for more information.",
261261
optional = true
262262
) Expression options

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MultiMatch.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ public MultiMatch(
250250
+ "See <<multi-match-types,multi_match types>>."
251251
), },
252252
description = "(Optional) Additional options for MultiMatch, "
253-
+ "passed as <<esql-function-named-params,function named parameters>>.{applies_to}`stack: ga 9.1`\"\n"
253+
+ "passed as <<esql-function-named-params,function named parameters>>.{applies_to}`stack: coming`\"\n"
254254
+ " See <<query-dsl-multi-match-query,multi-match query>> for more information.",
255255
optional = true
256256
) Expression options

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToLower.java

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,21 @@ public class ToLower extends ChangeCase {
2828
@FunctionInfo(
2929
returnType = { "keyword" },
3030
description = "Returns a new string representing the input string converted to lower case.",
31-
examples = { @Example(file = "string", tag = "to_lower"), @Example(file = "string", tag = "to_lower_mv", applies_to = "stack: ga 9.1") }
31+
examples = { @Example(file = "string", tag = "to_lower"), @Example(file = "string", tag = "to_lower_mv") }
3232
)
33-
public ToLower(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """
34-
String expression. If `null`, the function returns `null`. The input can be:
33+
34+
public ToLower(Source source, @Param(
35+
name = "str",
36+
type = { "keyword", "text" },
37+
description = """
38+
String expression. If `null`, the function returns `null`.
39+
40+
The input can be:
3541
3642
- a single-valued column or expression
37-
38-
- a multi-valued column or expression {applies_to}`stack: ga 9.1`""") Expression field, Configuration configuration) {
43+
44+
- a multi-valued column or expression {applies_to}`stack: coming`""")
45+
Expression field, Configuration configuration) {
3946
super(source, field, configuration, Case.LOWER);
4047
}
4148

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToUpper.java

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,19 @@ public class ToUpper extends ChangeCase {
3030
@FunctionInfo(
3131
returnType = { "keyword" },
3232
description = "Returns a new string representing the input string converted to upper case.",
33-
examples = @Example(file = "string", tag = "to_upper"),
34-
appliesTo = {
35-
@FunctionAppliesTo(
36-
lifeCycle = FunctionAppliesToLifecycle.COMING,
37-
version = "9.1.0",
38-
description = "Support for multivalued parameters is only available from 9.1.0"
39-
) }
33+
examples = @Example(file = "string", tag = "to_upper")
4034
)
41-
public ToUpper(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """
35+
public ToUpper(Source source, @Param(name = "str",
36+
type = { "keyword", "text" },
37+
description = """
4238
String expression. If `null`, the function returns `null`.
43-
The input can be a single- or multi-valued column or an expression.""") Expression field, Configuration configuration) {
39+
40+
The input can be:
41+
42+
- a single-valued column or expression
43+
44+
- a multi-valued column or expression {applies_to}`stack: coming`""")
45+
Expression field, Configuration configuration) {
4446
super(source, field, configuration, Case.UPPER);
4547
}
4648

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3SupportTests.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ public void testRenderingLayoutFromClass() throws Exception {
312312
313313
## `COUNT` [esql-count]
314314
```{applies_to}
315-
stack: coming 9.1.0
315+
stack: coming
316316
```
317317
318318
**Syntax**
@@ -417,8 +417,7 @@ public static class TestClass extends Function {
417417
) },
418418
appliesTo = {
419419
@FunctionAppliesTo(
420-
lifeCycle = FunctionAppliesToLifecycle.COMING,
421-
version = "9.1.0"
420+
lifeCycle = FunctionAppliesToLifecycle.COMING
422421
) }
423422
)
424423
public TestClass(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """

0 commit comments

Comments
 (0)