Skip to content

Commit 3acaff2

Browse files
authored
[DOCS] Move EQL APIs to separate page (#74846) (#74860)
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.
1 parent cc7d347 commit 3acaff2

File tree

3 files changed

+22
-20
lines changed

3 files changed

+22
-20
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[[eql-apis]]
2+
== EQL APIs
3+
4+
Event Query Language (EQL) is a query language for event-based time series data,
5+
such as logs, metrics, and traces. For an overview of EQL and related tutorials,
6+
see <<eql>>.
7+
8+
* <<eql-search-api>>
9+
* <<get-async-eql-search-api>>
10+
* <<get-async-eql-status-api>>
11+
* <<delete-async-eql-search-api>>
12+
13+
include::delete-async-eql-search-api.asciidoc[]
14+
15+
include::eql-search-api.asciidoc[]
16+
17+
include::get-async-eql-search-api.asciidoc[]
18+
19+
include::get-async-eql-status-api.asciidoc[]

docs/reference/rest-api/index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ not be included yet.
1919
* <<data-stream-apis,Data stream APIs>>
2020
* <<docs, Document APIs>>
2121
* <<enrich-apis,Enrich APIs>>
22-
* <<graph-explore-api,Graph explore API>>
22+
* <<eql-apis,EQL search APIs>>
2323
* <<find-structure,Find structure API>>
2424
* <<fleet-apis,Fleet APIs>>
25+
* <<graph-explore-api,Graph explore API>>
2526
* <<indices, Index APIs>>
2627
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
2728
* <<ingest-apis,Ingest APIs>>
@@ -53,6 +54,7 @@ include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[]
5354
include::{es-repo-dir}/data-streams/data-stream-apis.asciidoc[]
5455
include::{es-repo-dir}/docs.asciidoc[]
5556
include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[]
57+
include::{es-repo-dir}/eql/eql-apis.asciidoc[]
5658
include::{es-repo-dir}/features/apis/features-apis.asciidoc[]
5759
include::{es-repo-dir}/fleet/index.asciidoc[]
5860
include::{es-repo-dir}/text-structure/apis/find-structure.asciidoc[leveloffset=+1]

docs/reference/search.asciidoc

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,6 @@ exception of the <<search-explain,explain API>>.
3939
* <<multi-search-template>>
4040
* <<render-search-template-api>>
4141

42-
[discrete]
43-
[[eql-search-apis]]
44-
=== EQL search
45-
46-
For an overview of EQL and related tutorials, see <<eql>>.
47-
48-
* <<eql-search-api>>
49-
* <<get-async-eql-search-api>>
50-
* <<get-async-eql-status-api>>
51-
* <<delete-async-eql-search-api>>
52-
5342

5443
include::search/search.asciidoc[]
5544

@@ -73,14 +62,6 @@ include::search/suggesters.asciidoc[]
7362

7463
include::search/multi-search.asciidoc[]
7564

76-
include::eql/eql-search-api.asciidoc[]
77-
78-
include::eql/get-async-eql-search-api.asciidoc[]
79-
80-
include::eql/get-async-eql-status-api.asciidoc[]
81-
82-
include::eql/delete-async-eql-search-api.asciidoc[]
83-
8465
include::search/count.asciidoc[]
8566

8667
include::search/validate.asciidoc[]

0 commit comments

Comments
 (0)