Skip to content

Commit

Permalink
[DOCS] Add links to SQL and synonyms APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 31, 2024
1 parent 478eb8c commit 9680c89
Show file tree
Hide file tree
Showing 15 changed files with 90 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/reference/sql/apis/clear-sql-cursor-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear SQL cursor</titleabbrev>
++++

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

Clears an <<sql-pagination,SQL search cursor>>.

////
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/sql/apis/delete-async-sql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete async SQL search</titleabbrev>
++++

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

Deletes an <<sql-async,async SQL search>> or a <<sql-store-searches,stored
synchronous SQL search>>. If the search is still running, the API cancels it.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/sql/apis/get-async-sql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Get async SQL search</titleabbrev>
++++

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

Returns results for an <<sql-async,async SQL search>> or a
<<sql-store-searches,stored synchronous SQL search>>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Get async SQL search status</titleabbrev>
++++

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

Returns the current status of an <<sql-async,async SQL search>> or a
<<sql-store-searches,stored synchronous SQL search>>.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/sql/apis/sql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>SQL search</titleabbrev>
++++

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

Returns results for an <<sql-rest-overview,SQL search>>.

[source,console]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/sql/apis/sql-translate-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>SQL translate</titleabbrev>
++++

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

Translates an <<sql-search-api,SQL search>> into a <<search-search,search API>>
request containing <<query-dsl,Query DSL>>. See <<sql-translate>>.

Expand Down
7 changes: 6 additions & 1 deletion docs/reference/synonyms/apis/delete-synonym-rule.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
[[delete-synonym-rule]]
=== Delete synonym rule

++++
<titleabbrev>Delete synonym rule</titleabbrev>
++++

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

Deletes an individual synonym rule from a synonyms set.

[[delete-synonym-rule-request]]
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/synonyms/apis/delete-synonyms-set.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
[[delete-synonyms-set]]
=== Delete synonyms set

++++
<titleabbrev>Delete synonyms set</titleabbrev>
++++

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

Deletes a synonyms set.

[[delete-synonyms-set-request]]
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/synonyms/apis/get-synonym-rule.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
[[get-synonym-rule]]
=== Get synonym rule

++++
<titleabbrev>Get synonym rule</titleabbrev>
++++

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

Retrieves a synonym rule from a synonyms set.

[[get-synonym-rule-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/synonyms/apis/get-synonyms-set.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Get synonyms set</titleabbrev>
++++

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

Retrieves a synonyms set.

[[get-synonyms-set-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/synonyms/apis/list-synonyms-sets.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>List synonyms sets</titleabbrev>
++++

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

Retrieves a summary of all defined synonyms sets.

This API allows to retrieve the total number of synonyms sets defined.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/synonyms/apis/put-synonym-rule.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create or update synonym rule</titleabbrev>
++++

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

Creates or updates a synonym rule for a synonym set.

[[put-synonym-rule-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/synonyms/apis/put-synonyms-set.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create or update synonyms set</titleabbrev>
++++

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

Creates or updates a synonyms set.

NOTE: Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/synonyms/apis/synonyms-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

---

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

The synonyms management API provides a convenient way to define and manage synonyms in an internal system index. Related synonyms can be grouped in a "synonyms set".
Create as many synonym sets as you need.

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

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

You can use the following APIs to find text structures:

* <<find-field-structure>>
Expand Down

0 comments on commit 9680c89

Please sign in to comment.