Browse Source

[DOCS] Remove collapsible sections in EQL fn docs (#61498)

James Rodewig 5 years ago
parent
commit
a7d4e8b148
2 changed files with 4 additions and 65 deletions
  1. 4 59
      docs/reference/eql/functions.asciidoc
  2. 0 6
      docs/reference/eql/pipes.asciidoc

+ 4 - 59
docs/reference/eql/functions.asciidoc

@@ -34,8 +34,6 @@ experimental::[]
 === `add`
 === `add`
 Returns the sum of two provided addends.
 Returns the sum of two provided addends.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -77,7 +75,6 @@ If using a field as the argument, this parameter supports only
 <<number,`numeric`>> field data types.
 <<number,`numeric`>> field data types.
 
 
 *Returns:* integer, float, or `null`
 *Returns:* integer, float, or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-between]]
 [[eql-fn-between]]
@@ -86,8 +83,6 @@ If using a field as the argument, this parameter supports only
 Extracts a substring that's between a provided `left` and `right` text in a
 Extracts a substring that's between a provided `left` and `right` text in a
 source string.
 source string.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -182,7 +177,6 @@ in regular expressions. Defaults to `false`.
 If `true`, matching is case-sensitive. Defaults to `false`.
 If `true`, matching is case-sensitive. Defaults to `false`.
 
 
 *Returns:* string or `null`
 *Returns:* string or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-cidrmatch]]
 [[eql-fn-cidrmatch]]
@@ -191,8 +185,6 @@ If `true`, matching is case-sensitive. Defaults to `false`.
 Returns `true` if an IP address is contained in one or more provided
 Returns `true` if an IP address is contained in one or more provided
 {wikipedia}/Classless_Inter-Domain_Routing[CIDR] blocks.
 {wikipedia}/Classless_Inter-Domain_Routing[CIDR] blocks.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 
 
 [source,eql]
 [source,eql]
@@ -231,7 +223,6 @@ field data type.
 CIDR block you wish to search. If `null`, the function returns `null`.
 CIDR block you wish to search. If `null`, the function returns `null`.
 
 
 *Returns:* boolean or `null`
 *Returns:* boolean or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-concat]]
 [[eql-fn-concat]]
@@ -239,8 +230,6 @@ CIDR block you wish to search. If `null`, the function returns `null`.
 
 
 Returns a concatenated string of provided values.
 Returns a concatenated string of provided values.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -282,19 +271,15 @@ If using a field as the argument, this parameter does not support the
 <<text,`text`>> field data type.
 <<text,`text`>> field data type.
 
 
 *Returns:* string or `null`
 *Returns:* string or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-divide]]
 [[eql-fn-divide]]
-==== `divide`
+=== `divide`
 Returns the quotient of a provided dividend and divisor.
 Returns the quotient of a provided dividend and divisor.
 
 
-[%collapsible]
-====
-
 [[eql-divide-fn-float-rounding]]
 [[eql-divide-fn-float-rounding]]
 [WARNING]
 [WARNING]
-=====
+====
 If both the dividend and divisor are integers, the `divide` function _rounds
 If both the dividend and divisor are integers, the `divide` function _rounds
 down_ any returned floating point numbers to the nearest integer.
 down_ any returned floating point numbers to the nearest integer.
 
 
@@ -303,7 +288,7 @@ either the dividend or divisor to a float.
 
 
 [%collapsible]
 [%collapsible]
 .**Example**
 .**Example**
-======
+=====
 The `process.args_count` field is a <<number,`long`>> integer field containing a
 The `process.args_count` field is a <<number,`long`>> integer field containing a
 count of process arguments.
 count of process arguments.
 
 
@@ -330,8 +315,8 @@ The following EQL query changes the integer `4` to the equivalent float `4.0`.
 ----
 ----
 process where divide(4.0, process.args_count) == 1
 process where divide(4.0, process.args_count) == 1
 ----
 ----
-======
 =====
 =====
+====
 
 
 *Example*
 *Example*
 [source,eql]
 [source,eql]
@@ -387,7 +372,6 @@ If using a field as the argument, this parameter supports only
 <<number,`numeric`>> field data types.
 <<number,`numeric`>> field data types.
 
 
 *Returns:* integer, float, or null
 *Returns:* integer, float, or null
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-endswith]]
 [[eql-fn-endswith]]
@@ -395,8 +379,6 @@ If using a field as the argument, this parameter supports only
 
 
 Returns `true` if a source string ends with a provided substring.
 Returns `true` if a source string ends with a provided substring.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -458,7 +440,6 @@ field data types:
 --
 --
 
 
 *Returns:* boolean or `null`
 *Returns:* boolean or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-indexof]]
 [[eql-fn-indexof]]
@@ -469,8 +450,6 @@ Returns the first position of a provided substring in a source string.
 If an optional start position is provided, this function returns the first
 If an optional start position is provided, this function returns the first
 occurrence of the substring at or after the start position.
 occurrence of the substring at or after the start position.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -566,7 +545,6 @@ If using a field as the argument, this parameter supports only the following
 --
 --
 
 
 *Returns:* integer or `null`
 *Returns:* integer or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-length]]
 [[eql-fn-length]]
@@ -575,8 +553,6 @@ If using a field as the argument, this parameter supports only the following
 Returns the character length of a provided string, including whitespace and
 Returns the character length of a provided string, including whitespace and
 punctuation.
 punctuation.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -614,7 +590,6 @@ field data types:
 --
 --
 
 
 *Returns:* integer or `null`
 *Returns:* integer or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-match]]
 [[eql-fn-match]]
@@ -623,8 +598,6 @@ field data types:
 Returns `true` if a source string matches one or more provided regular
 Returns `true` if a source string matches one or more provided regular
 expressions.
 expressions.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -679,15 +652,12 @@ Fields are not supported as arguments.
 --
 --
 
 
 *Returns:* boolean or `null`
 *Returns:* boolean or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-modulo]]
 [[eql-fn-modulo]]
 === `modulo`
 === `modulo`
 Returns the remainder of the division of a provided dividend and divisor.
 Returns the remainder of the division of a provided dividend and divisor.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -739,7 +709,6 @@ If using a field as the argument, this parameter supports only
 <<number,`numeric`>> field data types.
 <<number,`numeric`>> field data types.
 
 
 *Returns:* integer, float, or `null`
 *Returns:* integer, float, or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-multiply]]
 [[eql-fn-multiply]]
@@ -747,8 +716,6 @@ If using a field as the argument, this parameter supports only
 
 
 Returns the product of two provided factors.
 Returns the product of two provided factors.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -792,7 +759,6 @@ If using a field as the argument, this parameter supports only
 --
 --
 
 
 *Returns:* integer, float, or `null`
 *Returns:* integer, float, or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-number]]
 [[eql-fn-number]]
@@ -800,8 +766,6 @@ If using a field as the argument, this parameter supports only
 
 
 Converts a string to the corresponding integer or float.
 Converts a string to the corresponding integer or float.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -888,7 +852,6 @@ Fields are not supported as arguments.
 --
 --
 
 
 *Returns:* integer or float or `null`
 *Returns:* integer or float or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-startswith]]
 [[eql-fn-startswith]]
@@ -896,8 +859,6 @@ Fields are not supported as arguments.
 
 
 Returns `true` if a source string begins with a provided substring.
 Returns `true` if a source string begins with a provided substring.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -959,7 +920,6 @@ field data types:
 --
 --
 
 
 *Returns:* boolean or `null`
 *Returns:* boolean or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-string]]
 [[eql-fn-string]]
@@ -967,8 +927,6 @@ field data types:
 
 
 Converts a value to a string.
 Converts a value to a string.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -997,7 +955,6 @@ If using a field as the argument, this parameter does not support the
 <<text,`text`>> field data type.
 <<text,`text`>> field data type.
 
 
 *Returns:* string or `null`
 *Returns:* string or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-stringcontains]]
 [[eql-fn-stringcontains]]
@@ -1005,8 +962,6 @@ If using a field as the argument, this parameter does not support the
 
 
 Returns `true` if a source string contains a provided substring.
 Returns `true` if a source string contains a provided substring.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -1060,7 +1015,6 @@ field data types:
   <<constant-keyword,`constant_keyword`>> sub-field
   <<constant-keyword,`constant_keyword`>> sub-field
 
 
 *Returns:* boolean or `null`
 *Returns:* boolean or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-substring]]
 [[eql-fn-substring]]
@@ -1070,8 +1024,6 @@ Extracts a substring from a source string at provided start and end positions.
 
 
 If no end position is provided, the function extracts the remaining string.
 If no end position is provided, the function extracts the remaining string.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -1114,15 +1066,12 @@ function returns the remaining string.
 Positions are zero-indexed. Negative offsets are supported.
 Positions are zero-indexed. Negative offsets are supported.
 
 
 *Returns:* string
 *Returns:* string
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-subtract]]
 [[eql-fn-subtract]]
 === `subtract`
 === `subtract`
 Returns the difference between a provided minuend and subtrahend.
 Returns the difference between a provided minuend and subtrahend.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -1169,7 +1118,6 @@ If using a field as the argument, this parameter supports only
 <<number,`numeric`>> field data types.
 <<number,`numeric`>> field data types.
 
 
 *Returns:* integer, float, or `null`
 *Returns:* integer, float, or `null`
-====
 
 
 [discrete]
 [discrete]
 [[eql-fn-wildcard]]
 [[eql-fn-wildcard]]
@@ -1178,8 +1126,6 @@ If using a field as the argument, this parameter supports only
 Returns `true` if a source string matches one or more provided wildcard
 Returns `true` if a source string matches one or more provided wildcard
 expressions.
 expressions.
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 [source,eql]
 [source,eql]
 ----
 ----
@@ -1235,4 +1181,3 @@ returns `null`. Fields are not supported as arguments.
 --
 --
 
 
 *Returns:* boolean
 *Returns:* boolean
-====

+ 0 - 6
docs/reference/eql/pipes.asciidoc

@@ -21,8 +21,6 @@ Returns up to a specified number of events or sequences, starting with the
 earliest matches. Works similarly to the
 earliest matches. Works similarly to the
 {wikipedia}/Head_(Unix)[Unix head command].
 {wikipedia}/Head_(Unix)[Unix head command].
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 
 
 The following EQL query returns up to three of the earliest powershell
 The following EQL query returns up to three of the earliest powershell
@@ -45,7 +43,6 @@ head <max>
 `<max>`::
 `<max>`::
 (Required, integer)
 (Required, integer)
 Maximum number of matching events or sequences to return.
 Maximum number of matching events or sequences to return.
-====
 
 
 [discrete]
 [discrete]
 [[eql-pipe-tail]]
 [[eql-pipe-tail]]
@@ -55,8 +52,6 @@ Returns up to a specified number of events or sequences, starting with the most
 recent matches. Works similarly to the
 recent matches. Works similarly to the
 {wikipedia}/Tail_(Unix)[Unix tail command].
 {wikipedia}/Tail_(Unix)[Unix tail command].
 
 
-[%collapsible]
-====
 *Example*
 *Example*
 
 
 The following EQL query returns up to five of the most recent `svchost.exe`
 The following EQL query returns up to five of the most recent `svchost.exe`
@@ -79,4 +74,3 @@ tail <max>
 `<max>`::
 `<max>`::
 (Required, integer)
 (Required, integer)
 Maximum number of matching events or sequences to return.
 Maximum number of matching events or sequences to return.
-====