Skip to content

Commit

Permalink
[DOCS] Add links to query rollup and repositories APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 30, 2024
1 parent 871c88f commit 64bed83
Show file tree
Hide file tree
Showing 14 changed files with 84 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear repositories metering archive</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/operation/operation-nodes-clear-repositories-metering-archive[Clear the archived repositories metering API].
--

Removes the archived repositories metering information present in the cluster.

[[clear-repositories-metering-archive-api-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Get repositories metering information</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/operation/operation-nodes-get-repositories-metering-info[Get cluster repositories metering API].
--

Returns cluster repositories metering information.

[[get-repositories-metering-api-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

experimental[]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs].
--

You can use the following APIs to retrieve repositories metering information.

This is an API used by Elastic's commercial offerings.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/root.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
<titleabbrev>Root API</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-info[Info APIs].
--

The Elasticsearch API's base url returns its basic build,
version, and cluster information.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/delete-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Deletes an existing {rollup-job}.

[[rollup-delete-job-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/get-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Retrieves the configuration, stats, and status of {rollup-jobs}.

[[rollup-get-job-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/put-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ WARNING: From 8.15.0 invoking this API in a cluster with no rollup usage will fa
deprecation and planned removal. A cluster either needs to contain a rollup job or a rollup index in order for this API
to be allowed to execute.

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Creates a {rollup-job}.

[[rollup-put-job-api-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/rollup-caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Returns the capabilities of any {rollup-jobs} that have been configured for a
specific index or index pattern.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/rollup-index-caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the
index where rollup data is stored).

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/rollup-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Enables searching rolled-up data using the standard Query DSL.

[[rollup-search-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/start-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Starts an existing, stopped {rollup-job}.

[[rollup-start-job-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/apis/stop-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

Stops an existing, started {rollup-job}.

[[rollup-stop-job-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rollup/rollup-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

deprecated::[8.11.0,"Rollups will be removed in a future version. Please <<rollup-migrating-to-downsampling,migrate>> to <<downsampling,downsampling>> instead."]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs].
--

[discrete]
[[rollup-jobs-endpoint]]
=== Jobs
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/scripting/apis/script-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[script-apis]]
== Script APIs

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs].
--

Use the following APIs to manage, store, and test your
<<modules-scripting,scripts>>.

Expand Down

0 comments on commit 64bed83

Please sign in to comment.