honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Edits rollup API description (#37444)

This commit is contained in:
Lisa Cawley 2019-01-15 08:46:36 -08:00 committed by GitHub
parent 6129e9d9dd
commit 44e83f30e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/rollup/apis/rollup-caps.asciidoc
View File

@ -8,16 +8,19 @@
experimental[]
This API returns the rollup capabilities that have been configured for an index or index pattern. This API is useful
because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only
certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on
that configuration.
This API returns the capabilities of any rollup jobs that have been configured
for a specific index or index pattern.
This API will allow you to inspect an index and determine:
This API is useful because a rollup job is often configured to rollup only a
subset of fields from the source index. Furthermore, only certain aggregations
can be configured for various fields, leading to a limited subset of
functionality depending on that configuration.
This API enables you to inspect an index and determine:
1. Does this index have associated rollup data somewhere in the cluster?
2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data
live?
2. If yes to the first question, what fields were rolled up, what aggregations
can be performed, and where does the data live?
==== Request