Skip to content

Commit 2ef8257

Browse files
committed
[DOCS] Edit more rollup summaries
1 parent b38d789 commit 2ef8257

File tree

5 files changed

+28
-5
lines changed

5 files changed

+28
-5
lines changed

specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,18 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
24+
* Get the rollup job capabilities.
25+
* Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
26+
*
27+
* This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.
28+
* Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.
29+
* This API enables you to inspect an index and determine:
30+
*
31+
* 1. Does this index have associated rollup data somewhere in the cluster?
32+
* 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?
2533
* @rest_spec_name rollup.get_rollup_caps
2634
* @availability stack since=6.3.0 stability=experimental
35+
* @cluster_privileges monitor_rollup
2736
*/
2837
export interface Request extends RequestBase {
2938
path_parts: {

specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,15 @@ import { RequestBase } from '@_types/Base'
2121
import { Ids } from '@_types/common'
2222

2323
/**
24-
* Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
24+
* Get the rollup index capabilities.
25+
* Get the rollup capabilities of all jobs inside of a rollup index.
26+
* A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:
27+
*
28+
* * What jobs are stored in an index (or indices specified via a pattern)?
29+
* * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?
2530
* @rest_spec_name rollup.get_rollup_index_caps
2631
* @availability stack since=6.4.0 stability=experimental
32+
* @index_privileges read
2733
*/
2834
export interface Request extends RequestBase {
2935
path_parts: {

specification/rollup/rollup_search/RollupSearchRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ import { integer } from '@_types/Numeric'
2525
import { QueryContainer } from '@_types/query_dsl/abstractions'
2626

2727
/**
28-
* Enables searching rolled-up data using the standard Query DSL.
28+
* Search rolled-up data.
29+
* The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
30+
* It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.
2931
* @rest_spec_name rollup.rollup_search
3032
* @availability stack since=6.3.0 stability=experimental
3133
*/

specification/rollup/start_job/StartRollupJobRequest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Starts an existing, stopped rollup job.
24+
* Start rollup jobs.
25+
* If you try to start a job that does not exist, an exception occurs.
26+
* If you try to start a job that is already started, nothing happens.
2527
* @rest_spec_name rollup.start_job
2628
* @availability stack since=6.3.0 stability=experimental
29+
* @cluster_privileges manage_rollup
2730
*/
2831
export interface Request extends RequestBase {
2932
path_parts: {

specification/rollup/stop_job/StopRollupJobRequest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,12 @@ import { Id } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25-
* Stops an existing, started rollup job.
25+
* Stop rollup jobs.
26+
* If you try to stop a job that does not exist, an exception occurs.
27+
* If you try to stop a job that is already stopped, nothing happens.
2628
* @rest_spec_name rollup.stop_job
2729
* @availability stack since=6.3.0 stability=experimental
30+
* @cluster_privileges manage_rollup
2831
*/
2932
export interface Request extends RequestBase {
3033
path_parts: {

0 commit comments

Comments
 (0)