From ae5dac848d9d10fcdb7c939d4e091cbf60176e94 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 1 Jul 2021 15:01:53 -0400 Subject: [PATCH] [DOCS] Move EQL APIs to separate page (#74846) (#74859) In preparation for #74845, we need to create formal API reference documentation for our SQL APIs. Due to the number of SQL APIs, we'll likely need to create a separate nested page for them. For parity, this PR moves our EQL APIs to a separate page as well. Previously, they were listed under our search APIs. --- docs/reference/eql/eql-apis.asciidoc | 19 +++++++++++++++++++ docs/reference/rest-api/index.asciidoc | 4 +++- docs/reference/search.asciidoc | 19 ------------------- 3 files changed, 22 insertions(+), 20 deletions(-) create mode 100644 docs/reference/eql/eql-apis.asciidoc diff --git a/docs/reference/eql/eql-apis.asciidoc b/docs/reference/eql/eql-apis.asciidoc new file mode 100644 index 0000000000000..d3f591ccfe6c1 --- /dev/null +++ b/docs/reference/eql/eql-apis.asciidoc @@ -0,0 +1,19 @@ +[[eql-apis]] +== EQL APIs + +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 <>. + +* <> +* <> +* <> +* <> + +include::delete-async-eql-search-api.asciidoc[] + +include::eql-search-api.asciidoc[] + +include::get-async-eql-search-api.asciidoc[] + +include::get-async-eql-status-api.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 87888b45d5b40..934e296272cff 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -19,9 +19,10 @@ not be included yet. * <> * <> * <> -* <> +* <> * <> * <> +* <> * <> * <> * <> @@ -53,6 +54,7 @@ include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[] include::{es-repo-dir}/data-streams/data-stream-apis.asciidoc[] include::{es-repo-dir}/docs.asciidoc[] include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[] +include::{es-repo-dir}/eql/eql-apis.asciidoc[] include::{es-repo-dir}/features/apis/features-apis.asciidoc[] include::{es-repo-dir}/fleet/index.asciidoc[] include::{es-repo-dir}/text-structure/apis/find-structure.asciidoc[leveloffset=+1] diff --git a/docs/reference/search.asciidoc b/docs/reference/search.asciidoc index c7a776ea497af..06c3e0b26aaf6 100644 --- a/docs/reference/search.asciidoc +++ b/docs/reference/search.asciidoc @@ -39,17 +39,6 @@ exception of the <>. * <> * <> -[discrete] -[[eql-search-apis]] -=== EQL search - -For an overview of EQL and related tutorials, see <>. - -* <> -* <> -* <> -* <> - include::search/search.asciidoc[] @@ -73,14 +62,6 @@ include::search/suggesters.asciidoc[] include::search/multi-search.asciidoc[] -include::eql/eql-search-api.asciidoc[] - -include::eql/get-async-eql-search-api.asciidoc[] - -include::eql/get-async-eql-status-api.asciidoc[] - -include::eql/delete-async-eql-search-api.asciidoc[] - include::search/count.asciidoc[] include::search/validate.asciidoc[]