Browse Source

[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497)

With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
Luca Cavanna 7 years ago
parent
commit
075fdc579f

+ 0 - 0
docs/java-rest/high-level/builders/aggs.asciidoc → docs/java-rest/high-level/aggs-builders.asciidoc


+ 0 - 35
docs/java-rest/high-level/apis/index.asciidoc

@@ -1,35 +0,0 @@
-include::create_index.asciidoc[]
-
-include::indices_exists.asciidoc[]
-
-include::delete_index.asciidoc[]
-
-include::open_index.asciidoc[]
-
-include::close_index.asciidoc[]
-
-include::put_mapping.asciidoc[]
-
-include::update_aliases.asciidoc[]
-
-include::exists_alias.asciidoc[]
-
-include::shrink_index.asciidoc[]
-
-include::split_index.asciidoc[]
-
-include::_index.asciidoc[]
-
-include::get.asciidoc[]
-
-include::delete.asciidoc[]
-
-include::update.asciidoc[]
-
-include::bulk.asciidoc[]
-
-include::search.asciidoc[]
-
-include::scroll.asciidoc[]
-
-include::main.asciidoc[]

+ 0 - 0
docs/java-rest/high-level/apis/bulk.asciidoc → docs/java-rest/high-level/document/bulk.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/delete.asciidoc → docs/java-rest/high-level/document/delete.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/get.asciidoc → docs/java-rest/high-level/document/get.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/_index.asciidoc → docs/java-rest/high-level/document/index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/update.asciidoc → docs/java-rest/high-level/document/update.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/close_index.asciidoc → docs/java-rest/high-level/indices/close_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/create_index.asciidoc → docs/java-rest/high-level/indices/create_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/delete_index.asciidoc → docs/java-rest/high-level/indices/delete_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/exists_alias.asciidoc → docs/java-rest/high-level/indices/exists_alias.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/indices_exists.asciidoc → docs/java-rest/high-level/indices/indices_exists.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/open_index.asciidoc → docs/java-rest/high-level/indices/open_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/put_mapping.asciidoc → docs/java-rest/high-level/indices/put_mapping.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/shrink_index.asciidoc → docs/java-rest/high-level/indices/shrink_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/split_index.asciidoc → docs/java-rest/high-level/indices/split_index.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/update_aliases.asciidoc → docs/java-rest/high-level/indices/update_aliases.asciidoc


+ 2 - 2
docs/java-rest/high-level/java-builders.asciidoc

@@ -28,5 +28,5 @@ to compute with a search query in <<java-rest-high-document-search-request-build
 The <<java-rest-high-aggregation-builders, Building Aggregations>> page gives a list of all available
 aggregations with their corresponding `AggregationBuilder` objects and `AggregationBuilders` helper methods.
 
-include::builders/queries.asciidoc[]
-include::builders/aggs.asciidoc[]
+include::query-builders.asciidoc[]
+include::aggs-builders.asciidoc[]

+ 0 - 0
docs/java-rest/high-level/apis/main.asciidoc → docs/java-rest/high-level/miscellaneous/main.asciidoc


+ 0 - 0
docs/java-rest/high-level/builders/queries.asciidoc → docs/java-rest/high-level/query-builders.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/scroll.asciidoc → docs/java-rest/high-level/search/scroll.asciidoc


+ 0 - 0
docs/java-rest/high-level/apis/search.asciidoc → docs/java-rest/high-level/search/search.asciidoc


+ 55 - 17
docs/java-rest/high-level/supported-apis.asciidoc

@@ -1,35 +1,73 @@
 [[java-rest-high-supported-apis]]
-== Supported APIs
 
-The Java High Level REST Client supports the following APIs:
+== Document APIs
 
-Indices APIs::
-* <<java-rest-high-create-index>>
-* <<java-rest-high-delete-index>>
-* <<java-rest-high-indices-exists>>
-* <<java-rest-high-open-index>>
-* <<java-rest-high-close-index>>
-* <<java-rest-high-put-mapping>>
-* <<java-rest-high-update-aliases>>
-* <<java-rest-high-exists-alias>>
-* <<java-rest-high-shrink-index>>
-* <<java-rest-high-split-index>>
+The Java High Level REST Client supports the following Document APIs:
 
+[[single-doc]]
 Single document APIs::
 * <<java-rest-high-document-index>>
 * <<java-rest-high-document-get>>
 * <<java-rest-high-document-delete>>
 * <<java-rest-high-document-update>>
 
-Multi document APIs::
+[[multi-doc]]
+Multi-document APIs::
 * <<java-rest-high-document-bulk>>
 
-Search APIs::
+include::document/index.asciidoc[]
+include::document/get.asciidoc[]
+include::document/delete.asciidoc[]
+include::document/update.asciidoc[]
+include::document/bulk.asciidoc[]
+
+== Search APIs
+
+The Java High Level REST Client supports the following Search APIs:
+
 * <<java-rest-high-search>>
 * <<java-rest-high-search-scroll>>
 * <<java-rest-high-clear-scroll>>
 
-Miscellaneous APIs::
+include::search/search.asciidoc[]
+include::search/scroll.asciidoc[]
+
+== Miscellaneous APIs
+
+The Java High Level REST Client supports the following Miscellaneous APIs:
+
 * <<java-rest-high-main>>
 
-include::apis/index.asciidoc[]
+include::miscellaneous/main.asciidoc[]
+
+== Indices APIs
+
+The Java High Level REST Client supports the following Indices APIs:
+
+Index Management::
+* <<java-rest-high-create-index>>
+* <<java-rest-high-delete-index>>
+* <<java-rest-high-indices-exists>>
+* <<java-rest-high-open-index>>
+* <<java-rest-high-close-index>>
+* <<java-rest-high-shrink-index>>
+* <<java-rest-high-split-index>>
+
+Mapping Management::
+* <<java-rest-high-put-mapping>>
+
+Alias Management::
+* <<java-rest-high-update-aliases>>
+* <<java-rest-high-exists-alias>>
+
+include::indices/create_index.asciidoc[]
+include::indices/delete_index.asciidoc[]
+include::indices/indices_exists.asciidoc[]
+include::indices/open_index.asciidoc[]
+include::indices/close_index.asciidoc[]
+include::indices/shrink_index.asciidoc[]
+include::indices/split_index.asciidoc[]
+include::indices/put_mapping.asciidoc[]
+include::indices/update_aliases.asciidoc[]
+include::indices/exists_alias.asciidoc[]
+