Skip to content

Commit

Permalink
[DOCS] Add links to text structure and transform APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 31, 2024
1 parent 9680c89 commit f24160c
Show file tree
Hide file tree
Showing 17 changed files with 102 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/reference/rest-api/usage.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
[[usage-api]]
== Usage API

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

Provides usage information about the installed {xpack} features.

[discrete]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
[[find-field-structure]]
= Find field structure API

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

Finds the structure of a field in an Elasticsearch index.

[discrete]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
[[find-message-structure]]
= Find messages structure API

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

Finds the structure of a list of text messages.

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

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

Finds the structure of text. The text must
contain data that is suitable to be ingested into the
{stack}.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/text-structure/apis/test-grok-pattern.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
<titleabbrev>Test Grok pattern</titleabbrev>
++++

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

Tests a Grok pattern on lines of text, see also <<grok,Grokking grok>>.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/delete-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Delete {transform}</titleabbrev>
++++

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

Deletes an existing {transform}.

[[delete-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/get-transform-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Get {transform} statistics</titleabbrev>
++++

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

Retrieves usage information for {transforms}.


Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/get-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
<titleabbrev>Get {transforms}</titleabbrev>
++++

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

Retrieves configuration information for {transforms}.

[[get-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/preview-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Preview {transform}</titleabbrev>
++++

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

Previews a {transform}.

[[preview-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/put-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Create {transform}</titleabbrev>
++++

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

Instantiates a {transform}.

[[put-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/reset-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
<titleabbrev>Reset {transform}</titleabbrev>
++++

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

Resets a {transform}.

[[reset-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/schedule-now-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
<titleabbrev>Schedule now {transform}</titleabbrev>
++++

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

Instantly runs a {transform} to process data.

[[schedule-now-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/start-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Start {transform}</titleabbrev>
++++

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

Starts a {transform}.

[[start-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/stop-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Stop {transforms}</titleabbrev>
++++

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

Stops one or more {transforms}.


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

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

* <<put-transform>>
* <<delete-transform>>
* <<get-transform>>
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/update-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Update {transform}</titleabbrev>
++++

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

Updates certain properties of a {transform}.

[[update-transform-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/transform/apis/upgrade-transforms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
<titleabbrev>Upgrade {transforms}</titleabbrev>
++++

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

Upgrades all {transforms}.

[[upgrade-transforms-request]]
Expand Down

0 comments on commit f24160c

Please sign in to comment.