honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/supported-apis.asciidoc

102 lines
2.7 KiB
Plaintext
Raw Normal View History

[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
[[java-rest-high-supported-apis]]
Add first High level client documentation The REST Client is split into 2 parts: * Low level * High level The High level client has a main common section and the document delete API documentation as a start.
2017-02-24 07:52:36 -05:00
[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
2018-02-02 11:19:50 -05:00
== Document APIs
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
[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
2018-02-02 11:19:50 -05:00
The Java High Level REST Client supports the following Document APIs:
Add Delete Index API support to high-level REST client (#27019) Relates to #25847
2017-10-26 03:52:46 -04:00
[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
2018-02-02 11:19:50 -05:00
[[single-doc]]
[Docs] Add "Using Java Builders" section (#26517) The current "Building Queries" and "Building Aggregations" pages are located under the "Supported Apis" section because they are linked to the "Search API" page. It should instead be in a dedicated section: this commit adds a new "Using Java Builders" section and renames few filenames in favor of more meaningful names.
2017-09-06 08:06:41 -04:00
Single document APIs::
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
* <<java-rest-high-document-index>>
[DOCS] add docs for high level client get method (#25538) Document high level client get method
2017-07-05 05:57:57 -04:00
* <<java-rest-high-document-get>>
Add first High level client documentation The REST Client is split into 2 parts: * Low level * High level The High level client has a main common section and the document delete API documentation as a start.
2017-02-24 07:52:36 -05:00
* <<java-rest-high-document-delete>>
[Docs] Document Update API for Java High Level REST Client (#25536) This commit adds documentation for Java High Level REST Client's Update API.
2017-07-05 06:16:42 -04:00
* <<java-rest-high-document-update>>
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
[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
2018-02-02 11:19:50 -05:00
[[multi-doc]]
Multi-document APIs::
[Docs] Document Bulk API for Java High Level REST Client (#25532) This commit adds documentation for Java High Level REST Client's Bulk API.
2017-07-05 03:26:26 -04:00
* <<java-rest-high-document-bulk>>
Docs: HighLevelRestClient#multiGet (#29095) Add documentation for HighLevelRestClient#multiGet. Relates to #28389.
2018-03-16 18:52:34 -04:00
* <<java-rest-high-document-multi-get>>
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
[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
2018-02-02 11:19:50 -05:00
include::document/index.asciidoc[]
include::document/get.asciidoc[]
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
include::document/exists.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
include::document/delete.asciidoc[]
include::document/update.asciidoc[]
include::document/bulk.asciidoc[]
Docs: HighLevelRestClient#multiGet (#29095) Add documentation for HighLevelRestClient#multiGet. Relates to #28389.
2018-03-16 18:52:34 -04:00
include::document/multi-get.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
== Search APIs
The Java High Level REST Client supports the following Search APIs:
[Docs] Document Scroll API for Java High Level REST Client (#25554) This commit adds documentation for _search/scroll and clear scroll methods of the high level Java REST client
2017-07-07 06:19:33 -04:00
* <<java-rest-high-search>>
* <<java-rest-high-search-scroll>>
* <<java-rest-high-clear-scroll>>
Docs: HighLevelRestClient#multiSearch (#29144) Adds docs for `HighLevelRestClient#multiSearch`. Unlike the `multiGet` docs these are much more sparse because multi-search doesn't support setting many options on the `MultiSearchRequest` and instead just wraps a list of `SearchRequest`s. Closes #28389
2018-03-23 10:11:50 -04:00
* <<java-rest-high-multi-search>>
[Docs] Add rankEval method for Jva HL client This change adds documentation about using the ranking evaluation API from the high level Java REST client. Closes #28694
2018-04-10 04:15:31 -04:00
* <<java-rest-high-rank-eval>>
[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
[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
2018-02-02 11:19:50 -05:00
include::search/search.asciidoc[]
include::search/scroll.asciidoc[]
Docs: HighLevelRestClient#multiSearch (#29144) Adds docs for `HighLevelRestClient#multiSearch`. Unlike the `multiGet` docs these are much more sparse because multi-search doesn't support setting many options on the `MultiSearchRequest` and instead just wraps a list of `SearchRequest`s. Closes #28389
2018-03-23 10:11:50 -04:00
include::search/multi-search.asciidoc[]
[Docs] Add rankEval method for Jva HL client This change adds documentation about using the ranking evaluation API from the high level Java REST client. Closes #28694
2018-04-10 04:15:31 -04:00
include::search/rank-eval.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
== Miscellaneous APIs
The Java High Level REST Client supports the following Miscellaneous APIs:
[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
* <<java-rest-high-main>>
Docs: HighLevelRestClient#ping (#29070) Add documentation for `HighLevelRestClient#ping`. Relates to #28389
2018-03-14 14:27:01 -04:00
* <<java-rest-high-ping>>
[Docs] Add "Using Java Builders" section (#26517) The current "Building Queries" and "Building Aggregations" pages are located under the "Supported Apis" section because they are linked to the "Search API" page. It should instead be in a dedicated section: this commit adds a new "Using Java Builders" section and renames few filenames in favor of more meaningful names.
2017-09-06 08:06:41 -04:00
[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
2018-02-02 11:19:50 -05:00
include::miscellaneous/main.asciidoc[]
Docs: HighLevelRestClient#ping (#29070) Add documentation for `HighLevelRestClient#ping`. Relates to #28389
2018-03-14 14:27:01 -04:00
include::miscellaneous/ping.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
== 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>>
Add Refresh API for RestHighLevelClient (#27799) Relates to #27205
2018-02-28 05:49:14 -05:00
* <<java-rest-high-refresh>>
REST high-level client: add flush API (#28852) Relates to #27205
2018-03-01 04:56:03 -05:00
* <<java-rest-high-flush>>
REST high-level client: add clear cache API (#28866) * REST high-level client: add clear cache API Relates to #27205 Also Closes #26947 (rest-spec were outdated)
2018-03-20 05:39:36 -04:00
* <<java-rest-high-clear-cache>>
REST high-level client: add force merge API (#28896) Relates to #27205
2018-03-22 12:17:16 -04:00
* <<java-rest-high-force-merge>>
REST high-level client: add support for Rollover Index API (#28698) Relates to #27205
2018-02-20 09:58:58 -05:00
* <<java-rest-high-rollover-index>>
REST high-level client: add support for Indices Update Settings API [take 2] (#29327) Relates to #27205
2018-04-16 15:39:11 -04:00
* <<java-rest-high-indices-put-settings>>
[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
2018-02-02 11:19:50 -05:00
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[]
Add Refresh API for RestHighLevelClient (#27799) Relates to #27205
2018-02-28 05:49:14 -05:00
include::indices/refresh.asciidoc[]
REST high-level client: add flush API (#28852) Relates to #27205
2018-03-01 04:56:03 -05:00
include::indices/flush.asciidoc[]
REST high-level client: add clear cache API (#28866) * REST high-level client: add clear cache API Relates to #27205 Also Closes #26947 (rest-spec were outdated)
2018-03-20 05:39:36 -04:00
include::indices/clear_cache.asciidoc[]
REST high-level client: add force merge API (#28896) Relates to #27205
2018-03-22 12:17:16 -04:00
include::indices/force_merge.asciidoc[]
REST high-level client: add support for Rollover Index API (#28698) Relates to #27205
2018-02-20 09:58:58 -05:00
include::indices/rollover.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
include::indices/put_mapping.asciidoc[]
include::indices/update_aliases.asciidoc[]
include::indices/exists_alias.asciidoc[]
REST high-level client: add support for Indices Update Settings API [take 2] (#29327) Relates to #27205
2018-04-16 15:39:11 -04:00
include::indices/put_settings.asciidoc[]
[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
2018-02-02 11:19:50 -05:00
Add Cluster Put Settings API to the high level REST client (#28633) Relates to #27205
2018-02-15 11:21:45 -05:00
== Cluster APIs
The Java High Level REST Client supports the following Cluster APIs:
* <<java-rest-high-cluster-put-settings>>
include::cluster/put_settings.asciidoc[]