Skip to content

Commit db89764

Browse files
authored
[DOCS] Add data streams to rollup APIs (#59423) (#59465)
1 parent 81bdb20 commit db89764

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

docs/reference/rollup/apis/rollup-index-caps.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ experimental[]
1414
[[rollup-get-rollup-index-caps-request]]
1515
==== {api-request-title}
1616

17-
`GET <index>/_rollup/data`
17+
`GET <target>/_rollup/data`
1818

1919
[[rollup-get-rollup-index-caps-prereqs]]
2020
==== {api-prereq-title}
@@ -38,9 +38,9 @@ and what aggregations can be performed on each job?
3838
[[rollup-get-rollup-index-caps-path-params]]
3939
==== {api-path-parms-title}
4040

41-
`<index>`::
42-
(Required, string) Index or index-pattern of concrete rollup indices to check
43-
for capabilities.
41+
`<target>`::
42+
(Required, string) Data stream or index to check for rollup capabilities.
43+
Wildcard (`*`) expressions are supported.
4444

4545
[[rollup-get-rollup-index-caps-example]]
4646
==== {api-examples-title}

docs/reference/rollup/apis/rollup-search.asciidoc

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<titleabbrev>Rollup search</titleabbrev>
77
++++
88

9-
Enables searching rolled-up data using the standard query DSL.
9+
Enables searching rolled-up data using the standard query DSL.
1010

1111
experimental[]
1212

1313
[[rollup-search-request]]
1414
==== {api-request-title}
1515

16-
`GET <index>/_rollup_search`
16+
`GET <target>/_rollup_search`
1717

1818
[[rollup-search-desc]]
1919
==== {api-description-title}
@@ -27,20 +27,28 @@ expect given the original query.
2727
[[rollup-search-path-params]]
2828
==== {api-path-parms-title}
2929

30-
`<index>`::
31-
(Required, string) Index, indices or index-pattern to execute a rollup search
32-
against. This can include both rollup and non-rollup indices.
30+
`<target>`::
31+
+
32+
--
33+
(Required, string)
34+
Comma-separated list of data streams and indices used to limit
35+
the request. Wildcard expressions (`*`) are supported.
3336

34-
Rules for the `index` parameter:
37+
This target can include both rollup and non-rollup indices.
3538

36-
- At least one index/index-pattern must be specified. This can be either a
37-
rollup or non-rollup index. Omitting the index parameter, or using `_all`, is
38-
not permitted.
39-
- Multiple non-rollup indices may be specified
39+
Rules for the `<target>` parameter:
40+
41+
- At least one data stream, index, or wildcard expression must be specified.
42+
This target can include a rollup or non-rollup index. For data streams, the
43+
stream's backing indices can only serve as non-rollup indices. Omitting the
44+
`<target>` parameter or using `_all` is not permitted.
45+
- Multiple non-rollup indices may be specified.
4046
- Only one rollup index may be specified. If more than one are supplied, an
4147
exception occurs.
42-
- Index patterns may be used, but if they match more than one rollup index an
43-
exception occurs.
48+
- Wildcard expressions may be used, but, if they match more than one rollup index, an
49+
exception occurs. However, you can use an expression to match multiple non-rollup
50+
indices or data streams.
51+
--
4452

4553
[[rollup-search-request-body]]
4654
==== {api-request-body-title}

0 commit comments

Comments
 (0)