Skip to content

Commit

Permalink
[DOCS] Draft API redirect messages
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 17, 2024
1 parent e1d06a8 commit 3e0edfb
Show file tree
Hide file tree
Showing 44 changed files with 349 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/reference/autoscaling/apis/autoscaling-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ NOTE: {cloud-only}

You can use the following APIs to perform {cloud}/ec-autoscaling.html[autoscaling operations].

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

[discrete]
[[autoscaling-api-top-level]]
=== Top-Level
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/behavioral-analytics/apis/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ beta::[]

---

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////


Use the following APIs to manage tasks and resources related to <<behavioral-analytics-overview,Behavioral Analytics>>:

* <<put-analytics-collection>>
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/cat.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[cat]]
== Compact and aligned text (CAT) APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

["float",id="intro"]
=== Introduction

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ccr/apis/ccr-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[ccr-apis]]
== {ccr-cap} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to perform <<xpack-ccr,{ccr}>> operations.

[discrete]
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/cluster.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[cluster]]
== Cluster APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

["float",id="cluster-nodes"]
=== Node specification

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/connector/apis/connector-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[connector-apis]]
== Connector APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

beta::[]

The connector and sync jobs APIs provide a convenient way to create and manage Elastic <<es-connectors,connectors>>.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/data-streams/data-stream-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[data-stream-apis]]
== Data stream APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

The following APIs are available for managing <<data-streams,data streams>>:

* <<indices-create-data-stream>>
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[docs]]
== Document APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

This section starts with a short introduction to {es}'s <<docs-replication,data
replication model>>, followed by a detailed description of the following CRUD
APIs:
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/eql/eql-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[eql-apis]]
== EQL APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

<<eql,Event Query Language (EQL)>> is a query language for event-based time series data,
such as logs, metrics, and traces. For an overview of EQL and related tutorials,
see <<eql>>.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/esql/esql-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[esql-apis]]
== {esql} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

The <<esql,{es} Query Language ({esql})>> provides a powerful way to filter, transform,
and analyze data stored in {es}, and in the future in other runtimes. For an
overview of {esql} and related tutorials, see <<esql>>.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/features/apis/features-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[features-apis]]
== Features APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to introspect and manage Features provided
by Elasticsearch and Elasticsearch plugins.

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/fleet/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[fleet-apis]]
== Fleet APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

TIP: For the {kib} {fleet} APIs, see the
{fleet-guide}/fleet-api-docs.html[Fleet API Documentation].

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/graph/explore.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[graph-explore-api]]
== Graph explore API

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

The graph explore API enables you to extract and summarize information about
the documents and terms in an {es} data stream or index.

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/indices.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[indices]]
== Index APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

Index APIs are used to manage individual indices,
index settings, aliases, mappings, and index templates.

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/indices/apis/reload-analyzers.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[indices-reload-analyzers]]
== Reload search analyzers API

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

Reloads an index's <<search-analyzer,search analyzers>> and their resources.
For data streams, the API reloads search analyzers and resources for the
stream's backing indices.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/inference/inference-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[inference-apis]]
== {infer-cap} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure,
Google AI Studio or Hugging Face. For built-in models and models uploaded
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ingest/apis/enrich/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[enrich-apis]]
== Enrich APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

The following enrich APIs are available for managing <<enrich-policy,enrich
policies>>:

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ingest/apis/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
[[ingest-apis]]
== Ingest APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

Use ingest APIs to manage tasks and resources related to <<ingest,ingest
pipelines>> and processors.

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/licensing/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[licensing-apis]]
== Licensing APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to manage your licenses:

* <<delete-license>>
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/migration/migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[migration-api]]
== Migration APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

The migration APIs power {kib}'s **Upgrade Assistant** feature.

include::apis/shared-migration-apis-tip.asciidoc[]
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[ml-ad-apis]]
= {ml-cap} {anomaly-detect} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to perform {ml} {anomaly-detect} activities.

See also <<ml-apis>>, <<ml-df-analytics-apis>>, <<ml-df-trained-models-apis>>.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/ml/common/apis/ml-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[ml-apis]]
= {ml-cap} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to retrieve information related to the
{stack-ml-features}:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[ml-df-analytics-apis]]
= {ml-cap} {dfanalytics} APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to perform {ml} {dfanalytics} activities:

* <<put-dfanalytics,Create {dfanalytics-jobs}>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
[[ml-df-trained-models-apis]]
= {ml-cap} trained model APIs

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

You can use the following APIs to perform model management operations:

* <<clear-trained-model-deployment-cache>>
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/query-rules/apis/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@

---

////
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[behavioral analytics APIs].
--
////

<<search-using-query-rules,Query rules>> allow you to configure per-query rules that are applied at query time to queries that match the specific rule.
Query rules are organized into _rulesets_, collections of query rules that are matched against incoming queries.
Query rules are applied using the <<query-dsl-rule-query, rule query>>.
Expand Down
8 changes: 5 additions & 3 deletions docs/reference/rest-api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
{es} exposes REST APIs that are used by the UI components and can be called
directly to configure and access {es} features.

[NOTE]
We are working on including more {es} APIs in this section. Some content might
not be included yet.
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}[{es} APIs].
--

* <<api-conventions, API conventions>>
* <<common-options, Common Options>>
Expand Down
Loading

0 comments on commit 3e0edfb

Please sign in to comment.