-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ESQL: Generate kibana inline docs (#106782)
This takes a stab at generating the markdown files that Kibana uses for its inline help. It doesn't include all of the examples because the `@Example` annotation is not filled in - we're tracking that in #104247 (comment) There are some links in the output and they are in markdown syntax. We should figure out how to make them work for kibana.
- Loading branch information
Showing
167 changed files
with
9,196 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
{ | ||
"comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", | ||
"type" : "eval", | ||
"name" : "abs", | ||
"description" : "Returns the absolute value.", | ||
"signatures" : [ | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "double", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "integer", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "integer" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "long", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "long" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "unsigned_long", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "unsigned_long" | ||
} | ||
], | ||
"examples" : [ | ||
"ROW number = -1.0 \n| EVAL abs_number = ABS(number)", | ||
"FROM employees\n| KEEP first_name, last_name, height\n| EVAL abs_height = ABS(0.0 - height)" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
{ | ||
"comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", | ||
"type" : "eval", | ||
"name" : "acos", | ||
"description" : "Returns the arccosine of `n` as an angle, expressed in radians.", | ||
"signatures" : [ | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "double", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "integer", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "long", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "unsigned_long", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
} | ||
], | ||
"examples" : [ | ||
"ROW a=.9\n| EVAL acos=ACOS(a)" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
{ | ||
"comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", | ||
"type" : "eval", | ||
"name" : "asin", | ||
"description" : "Returns the arcsine of the input\nnumeric expression as an angle, expressed in radians.", | ||
"signatures" : [ | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "double", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "integer", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "long", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "unsigned_long", | ||
"optional" : false, | ||
"description" : "Number between -1 and 1. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
} | ||
], | ||
"examples" : [ | ||
"ROW a=.9\n| EVAL asin=ASIN(a)" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
{ | ||
"comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", | ||
"type" : "eval", | ||
"name" : "atan", | ||
"description" : "Returns the arctangent of the input\nnumeric expression as an angle, expressed in radians.", | ||
"signatures" : [ | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "double", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "integer", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "long", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
}, | ||
{ | ||
"params" : [ | ||
{ | ||
"name" : "number", | ||
"type" : "unsigned_long", | ||
"optional" : false, | ||
"description" : "Numeric expression. If `null`, the function returns `null`." | ||
} | ||
], | ||
"variadic" : false, | ||
"returnType" : "double" | ||
} | ||
], | ||
"examples" : [ | ||
"ROW a=12.9\n| EVAL atan=ATAN(a)" | ||
] | ||
} |
Oops, something went wrong.