Skip to content

Commit 29c6b2f

Browse files
committed
Improve map type repreesentation in Kibana files and docs
1 parent 72344b9 commit 29c6b2f

File tree

9 files changed

+13
-9
lines changed

9 files changed

+13
-9
lines changed

docs/reference/esql/functions/kibana/definition/match.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/parameters/match.asciidoc

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/signature/match.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/reference/esql/functions/types/match.asciidoc

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -539,8 +539,8 @@ public String toString() {
539539
public static class MapArgSignature extends ArgSignature {
540540
private final Map<String, MapEntryArgSignature> mapParams;
541541

542-
public MapArgSignature(String description, boolean optional, Map<String, MapEntryArgSignature> mapParams) {
543-
super("map", new String[] { "map" }, description, optional);
542+
public MapArgSignature(String name, String description, boolean optional, Map<String, MapEntryArgSignature> mapParams) {
543+
super(name, new String[] { "map" }, description, optional);
544544
this.mapParams = mapParams;
545545
}
546546

@@ -666,7 +666,7 @@ public static ArgSignature mapParam(MapParam mapParam) {
666666
MapEntryArgSignature mapArg = new MapEntryArgSignature(param.name(), valueHint, type, param.description());
667667
params.put(param.name(), mapArg);
668668
}
669-
return new EsqlFunctionRegistry.MapArgSignature(desc, mapParam.optional(), params);
669+
return new EsqlFunctionRegistry.MapArgSignature(mapParam.name(), desc, mapParam.optional(), params);
670670
}
671671

672672
public static ArgSignature paramWithoutAnnotation(String name) {

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
@Retention(RetentionPolicy.RUNTIME)
2525
@Target(ElementType.PARAMETER)
2626
public @interface MapParam {
27+
String name();
28+
2729
MapParamEntry[] params() default {};
2830

2931
String description() default "";

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ public Match(
173173
description = "Value to find in the provided field."
174174
) Expression matchQuery,
175175
@MapParam(
176+
name="options",
176177
params = {
177178
@MapParam.MapParamEntry(name = "analyzer", valueHint = { "standard" }, description = "Analyzer used to convert the text in the query value into token."),
178179
@MapParam.MapParamEntry(name = "auto_generate_synonyms_phrase_query", valueHint = { "true", "false" }, description = "If true, match phrase queries are automatically created for multi-term synonyms."),

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ public LogWithBaseInMap(
6969
description = "Numeric expression. If `null`, the function returns `null`."
7070
) Expression number,
7171
@MapParam(
72+
name = "options",
7273
params = { @MapParam.MapParamEntry(name = "base", valueHint = { "2", "2.0" }) },
7374
description = "Input value. The input is a valid constant map expression.",
7475
optional = true

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1209,7 +1209,7 @@ private static void renderKibanaFunctionDefinition(
12091209
builder.startObject();
12101210
builder.field("name", arg.name());
12111211
if (arg.mapArg()) {
1212-
builder.field("type", "map");
1212+
builder.field("type", "function named parameters");
12131213
builder.field(
12141214
"mapParams",
12151215
arg.mapParams()

0 commit comments

Comments
 (0)