[DOCS] Add data streams to rollup APIs (#59423) (#59465)

This commit is contained in:
James Rodewig 2020-07-13 16:57:40 -04:00 committed by GitHub
parent 81bdb20b8a
commit db89764539
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 16 deletions

View File

@ -14,7 +14,7 @@ experimental[]
[[rollup-get-rollup-index-caps-request]]
==== {api-request-title}
`GET <index>/_rollup/data`
`GET <target>/_rollup/data`
[[rollup-get-rollup-index-caps-prereqs]]
==== {api-prereq-title}
@ -38,9 +38,9 @@ and what aggregations can be performed on each job?
[[rollup-get-rollup-index-caps-path-params]]
==== {api-path-parms-title}
`<index>`::
(Required, string) Index or index-pattern of concrete rollup indices to check
for capabilities.
`<target>`::
(Required, string) Data stream or index to check for rollup capabilities.
Wildcard (`*`) expressions are supported.
[[rollup-get-rollup-index-caps-example]]
==== {api-examples-title}

View File

@ -6,14 +6,14 @@
<titleabbrev>Rollup search</titleabbrev>
++++
Enables searching rolled-up data using the standard query DSL.
Enables searching rolled-up data using the standard query DSL.
experimental[]
[[rollup-search-request]]
==== {api-request-title}
`GET <index>/_rollup_search`
`GET <target>/_rollup_search`
[[rollup-search-desc]]
==== {api-description-title}
@ -27,20 +27,28 @@ expect given the original query.
[[rollup-search-path-params]]
==== {api-path-parms-title}
`<index>`::
(Required, string) Index, indices or index-pattern to execute a rollup search
against. This can include both rollup and non-rollup indices.
`<target>`::
+
--
(Required, string)
Comma-separated list of data streams and indices used to limit
the request. Wildcard expressions (`*`) are supported.
Rules for the `index` parameter:
This target can include both rollup and non-rollup indices.
- At least one index/index-pattern must be specified. This can be either a
rollup or non-rollup index. Omitting the index parameter, or using `_all`, is
not permitted.
- Multiple non-rollup indices may be specified
Rules for the `<target>` parameter:
- At least one data stream, index, or wildcard expression must be specified.
This target can include a rollup or non-rollup index. For data streams, the
stream's backing indices can only serve as non-rollup indices. Omitting the
`<target>` parameter or using `_all` is not permitted.
- Multiple non-rollup indices may be specified.
- Only one rollup index may be specified. If more than one are supplied, an
exception occurs.
- Index patterns may be used, but if they match more than one rollup index an
exception occurs.
- Wildcard expressions may be used, but, if they match more than one rollup index, an
exception occurs. However, you can use an expression to match multiple non-rollup
indices or data streams.
--
[[rollup-search-request-body]]
==== {api-request-body-title}