Skip to content

Commit cd38a51

Browse files
committed
[DOCS] Add experimental tag to rollup APIs (#63206)
1 parent 509507d commit cd38a51

8 files changed

+15
-0
lines changed

docs/java-rest/high-level/rollup/delete_job.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
[id="{upid}-{api}"]
88
=== Delete Rollup Job API
99

10+
experimental::[]
1011

1112
[id="{upid}-{api}-request"]
1213
==== Request

docs/java-rest/high-level/rollup/get_job.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
[[java-rest-high-x-pack-rollup-get-job]]
33
=== Get Rollup Job API
44

5+
experimental::[]
6+
57
The Get Rollup Job API can be used to get one or all rollup jobs from the
68
cluster. It accepts a `GetRollupJobRequest` object as a request and returns
79
a `GetRollupJobResponse`.

docs/java-rest/high-level/rollup/get_rollup_caps.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[id="{upid}-x-pack-{api}"]
88
=== Get Rollup Capabilities API
99

10+
experimental::[]
11+
1012
The Get Rollup Capabilities API allows the user to query a target index pattern (`logstash-*`, etc)
1113
and determine if there are any rollup jobs that are/were configured to rollup that pattern.
1214
The API accepts a `GetRollupCapsRequest` object as a request and returns a `GetRollupCapsResponse`.

docs/java-rest/high-level/rollup/get_rollup_index_caps.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[id="{upid}-x-pack-{api}"]
88
=== Get Rollup Index Capabilities API
99

10+
experimental::[]
11+
1012
The Get Rollup Index Capabilities API allows the user to determine if a concrete index or index pattern contains
1113
stored rollup jobs and data. If it contains data stored from rollup jobs, the capabilities of those jobs
1214
are returned. The API accepts a `GetRollupIndexCapsRequest` object as a request and returns a `GetRollupIndexCapsResponse`.

docs/java-rest/high-level/rollup/put_job.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
[[java-rest-high-x-pack-rollup-put-job]]
33
=== Put Rollup Job API
44

5+
experimental::[]
6+
57
The Put Rollup Job API can be used to create a new Rollup job
68
in the cluster. The API accepts a `PutRollupJobRequest` object
79
as a request and returns a `PutRollupJobResponse`.

docs/java-rest/high-level/rollup/search.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[id="{upid}-{api}"]
88
=== Rollup Search API
99

10+
experimental::[]
11+
1012
The Rollup Search endpoint allows searching rolled-up data using the standard
1113
query DSL. The Rollup Search endpoint is needed because, internally,
1214
rolled-up documents utilize a different document structure than the original

docs/java-rest/high-level/rollup/start_job.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[id="{upid}-{api}"]
88
=== Start Rollup Job API
99

10+
experimental::[]
11+
1012
[id="{upid}-{api}-request"]
1113
==== Request
1214

docs/java-rest/high-level/rollup/stop_job.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[id="{upid}-{api}"]
88
=== Stop Rollup Job API
99

10+
experimental::[]
11+
1012
[id="{upid}-{api}-request"]
1113
==== Request
1214

0 commit comments

Comments
 (0)