[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
This commit is contained in:
Luca Cavanna 2018-02-02 17:19:50 +01:00 committed by GitHub
parent 7c2bcf3953
commit 075fdc579f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 57 additions and 54 deletions

View File

@ -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[]

View File

@ -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[]

View File

@ -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[]