Skip to content

Commit

Permalink
[DOCS] Edit more rollup summaries
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 14, 2024
1 parent b38d789 commit 2ef8257
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,18 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
* Get the rollup job capabilities.
* Get the capabilities of any rollup jobs that have been configured for a specific 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 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?
* @rest_spec_name rollup.get_rollup_caps
* @availability stack since=6.3.0 stability=experimental
* @cluster_privileges monitor_rollup
*/
export interface Request extends RequestBase {
path_parts: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ import { RequestBase } from '@_types/Base'
import { Ids } from '@_types/common'

/**
* Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
* Get the rollup index capabilities.
* Get the rollup capabilities of all jobs inside of a rollup index.
* 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:
*
* * What jobs are stored in an index (or indices specified via a pattern)?
* * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?
* @rest_spec_name rollup.get_rollup_index_caps
* @availability stack since=6.4.0 stability=experimental
* @index_privileges read
*/
export interface Request extends RequestBase {
path_parts: {
Expand Down
4 changes: 3 additions & 1 deletion specification/rollup/rollup_search/RollupSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ import { integer } from '@_types/Numeric'
import { QueryContainer } from '@_types/query_dsl/abstractions'

/**
* Enables searching rolled-up data using the standard Query DSL.
* Search rolled-up data.
* The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
* 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.
* @rest_spec_name rollup.rollup_search
* @availability stack since=6.3.0 stability=experimental
*/
Expand Down
5 changes: 4 additions & 1 deletion specification/rollup/start_job/StartRollupJobRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Starts an existing, stopped rollup job.
* Start rollup jobs.
* If you try to start a job that does not exist, an exception occurs.
* If you try to start a job that is already started, nothing happens.
* @rest_spec_name rollup.start_job
* @availability stack since=6.3.0 stability=experimental
* @cluster_privileges manage_rollup
*/
export interface Request extends RequestBase {
path_parts: {
Expand Down
5 changes: 4 additions & 1 deletion specification/rollup/stop_job/StopRollupJobRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@ import { Id } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Stops an existing, started rollup job.
* Stop rollup jobs.
* If you try to stop a job that does not exist, an exception occurs.
* If you try to stop a job that is already stopped, nothing happens.
* @rest_spec_name rollup.stop_job
* @availability stack since=6.3.0 stability=experimental
* @cluster_privileges manage_rollup
*/
export interface Request extends RequestBase {
path_parts: {
Expand Down

0 comments on commit 2ef8257

Please sign in to comment.