Skip to content

Commit 40b0a3a

Browse files
authored
[DOCS] Adjust high-level client x-pack docs (#32747)
- Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
1 parent ae0c303 commit 40b0a3a

File tree

5 files changed

+16
-9
lines changed

5 files changed

+16
-9
lines changed

docs/java-rest/high-level/x-pack/x-pack-usage.asciidoc renamed to docs/java-rest/high-level/miscellaneous/x-pack-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ retrieved using the `usage()` method:
1212
include-tagged::{doc-tests}/MiscellaneousDocumentationIT.java[x-pack-usage-execute]
1313
--------------------------------------------------
1414

15-
[[java-rest-high-x-pack-info-response]]
15+
[[java-rest-high-x-pack-usage-response]]
1616
==== Response
1717

1818
The returned `XPackUsageResponse` contains a `Map` keyed by feature name.

docs/java-rest/high-level/supported-apis.asciidoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,12 @@ The Java High Level REST Client supports the following Miscellaneous APIs:
5454
* <<java-rest-high-main>>
5555
* <<java-rest-high-ping>>
5656
* <<java-rest-high-x-pack-info>>
57-
* <<java-rest-high-x-pack-watcher-put-watch>>
58-
* <<java-rest-high-x-pack-watcher-delete-watch>>
57+
* <<java-rest-high-x-pack-usage>>
5958

6059
include::miscellaneous/main.asciidoc[]
6160
include::miscellaneous/ping.asciidoc[]
62-
include::x-pack/x-pack-info.asciidoc[]
63-
include::x-pack/watcher/put-watch.asciidoc[]
64-
include::x-pack/watcher/delete-watch.asciidoc[]
61+
include::miscellaneous/x-pack-info.asciidoc[]
62+
include::miscellaneous/x-pack-usage.asciidoc[]
6563

6664
== Indices APIs
6765

@@ -190,7 +188,6 @@ The Java High Level REST Client supports the following Scripts APIs:
190188
include::script/get_script.asciidoc[]
191189
include::script/delete_script.asciidoc[]
192190

193-
194191
== Licensing APIs
195192

196193
The Java High Level REST Client supports the following Licensing APIs:
@@ -200,3 +197,13 @@ The Java High Level REST Client supports the following Licensing APIs:
200197

201198
include::licensing/put-license.asciidoc[]
202199
include::licensing/get-license.asciidoc[]
200+
201+
== Watcher APIs
202+
203+
The Java High Level REST Client supports the following Watcher APIs:
204+
205+
* <<java-rest-high-x-pack-watcher-put-watch>>
206+
* <<java-rest-high-x-pack-watcher-delete-watch>>
207+
208+
include::watcher/put-watch.asciidoc[]
209+
include::watcher/delete-watch.asciidoc[]

docs/java-rest/high-level/x-pack/watcher/delete-watch.asciidoc renamed to docs/java-rest/high-level/watcher/delete-watch.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[java-rest-high-x-pack-watcher-delete-watch]]
2-
=== X-Pack Delete Watch API
2+
=== Delete Watch API
33

44
[[java-rest-high-x-pack-watcher-delete-watch-execution]]
55
==== Execution

docs/java-rest/high-level/x-pack/watcher/put-watch.asciidoc renamed to docs/java-rest/high-level/watcher/put-watch.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[java-rest-high-x-pack-watcher-put-watch]]
2-
=== X-Pack Put Watch API
2+
=== Put Watch API
33

44
[[java-rest-high-x-pack-watcher-put-watch-execution]]
55
==== Execution

0 commit comments

Comments
 (0)