ESQL - generate docs for snapshot functions (#113080)

elastic · Sep 19, 2024 · 838b5a8 · 838b5a8
1 parent 4af30db
commit 838b5a8
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 2 deletions.
diff --git a/docs/reference/esql/functions/description/categorize.asciidoc b/docs/reference/esql/functions/description/categorize.asciidoc
diff --git a/docs/reference/esql/functions/kibana/definition/categorize.json b/docs/reference/esql/functions/kibana/definition/categorize.json
diff --git a/docs/reference/esql/functions/kibana/docs/categorize.md b/docs/reference/esql/functions/kibana/docs/categorize.md
diff --git a/docs/reference/esql/functions/layout/categorize.asciidoc b/docs/reference/esql/functions/layout/categorize.asciidoc
diff --git a/docs/reference/esql/functions/parameters/categorize.asciidoc b/docs/reference/esql/functions/parameters/categorize.asciidoc
diff --git a/docs/reference/esql/functions/signature/categorize.svg b/docs/reference/esql/functions/signature/categorize.svg
diff --git a/docs/reference/esql/functions/types/categorize.asciidoc b/docs/reference/esql/functions/types/categorize.asciidoc
diff --git a/...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java b/...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java
@@ -63,7 +63,7 @@ public class Categorize extends GroupingFunction implements Validatable {
 
     private final Expression field;
 
-    @FunctionInfo(returnType = { "integer" }, description = "Categorizes text messages")
+    @FunctionInfo(returnType = { "integer" }, description = "Categorizes text messages.")
     public Categorize(
         Source source,
         @Param(name = "field", type = { "text", "keyword" }, description = "Expression to categorize") Expression field

diff --git a/.../test/java/org/elasticsearch/xpack/esql/expression/function/AbstractFunctionTestCase.java b/.../test/java/org/elasticsearch/xpack/esql/expression/function/AbstractFunctionTestCase.java
@@ -1194,7 +1194,7 @@ protected static String functionName() {
     }
 
     private static FunctionDefinition definition(String name) {
-        EsqlFunctionRegistry registry = new EsqlFunctionRegistry();
+        EsqlFunctionRegistry registry = new EsqlFunctionRegistry().snapshotRegistry();
         if (registry.functionExists(name)) {
             return registry.resolveFunction(name);
         }