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

282 lines
8.4 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>>
HLREST: add reindex API (#32679) Adds the reindex API to the high level REST client.
2018-08-28 13:02:23 -04:00
* <<java-rest-high-document-reindex>>
HLREST: add update by query API (#32760) Adds update by query to the high level rest client.
2018-09-02 15:15:00 -04:00
* <<java-rest-high-document-update-by-query>>
HLRC: Add delete by query API (#32782) Adds the delete-by-query API to the High Level REST Client.
2018-09-04 08:56:26 -04:00
* <<java-rest-high-document-delete-by-query>>
[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[]
HLREST: add reindex API (#32679) Adds the reindex API to the high level REST client.
2018-08-28 13:02:23 -04:00
include::document/reindex.asciidoc[]
HLREST: add update by query API (#32760) Adds update by query to the high level rest client.
2018-09-02 15:15:00 -04:00
include::document/update-by-query.asciidoc[]
HLRC: Add delete by query API (#32782) Adds the delete-by-query API to the High Level REST Client.
2018-09-04 08:56:26 -04:00
include::document/delete-by-query.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>>
Add support for search templates to the high-level REST client. (#30473)
2018-05-15 16:07:58 -04:00
* <<java-rest-high-search-template>>
Add MultiSearchTemplate support to High Level Rest client (#30836) Add MultiSearchTemplate support to High Level Rest client. Addresses part of #27205
2018-06-28 09:05:26 -04:00
* <<java-rest-high-multi-search-template>>
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>>
Add support for field capabilities to the high-level REST client. (#29664)
2018-04-26 12:50:37 -04:00
* <<java-rest-high-field-caps>>
[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>>
Add explain API to high-level REST client (#31387) Relates to #27205
2018-06-27 09:20:56 -04:00
* <<java-rest-high-explain>>
[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[]
Add support for search templates to the high-level REST client. (#30473)
2018-05-15 16:07:58 -04:00
include::search/search-template.asciidoc[]
Add MultiSearchTemplate support to High Level Rest client (#30836) Add MultiSearchTemplate support to High Level Rest client. Addresses part of #27205
2018-06-28 09:05:26 -04:00
include::search/multi-search-template.asciidoc[]
Add support for field capabilities to the high-level REST client. (#29664)
2018-04-26 12:50:37 -04:00
include::search/field-caps.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[]
Add explain API to high-level REST client (#31387) Relates to #27205
2018-06-27 09:20:56 -04:00
include::search/explain.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>>
HLREST: Add x-pack-info API (#31870) This is the first x-pack API we're adding to the high level REST client so there is a lot to talk about here! = Open source The *client* for these APIs is open source. We're taking the previously Elastic licensed files used for the `Request` and `Response` objects and relicensing them under the Apache 2 license. The implementation of these features is staying under the Elastic license. This lines up with how the rest of the Elasticsearch language clients work. = Location of the new files We're moving all of the `Request` and `Response` objects that we're relicensing to the `x-pack/protocol` directory. We're adding a copy of the Apache 2 license to the root fo the `x-pack/protocol` directory to line up with the language in the root `LICENSE.txt` file. All files in this directory will have the Apache 2 license header as well. We don't want there to be any confusion. Even though the files are under the `x-pack` directory, they are Apache 2 licensed. We chose this particular directory layout because it keeps the X-Pack stuff together and easier to think about. = Location of the API in the REST client We've been following the layout of the rest-api-spec files for other APIs and we plan to do this for the X-Pack APIs with one exception: we're dropping the `xpack` from the name of most of the APIs. So `xpack.graph.explore` will become `graph().explore()` and `xpack.license.get` will become `license().get()`. `xpack.info` and `xpack.usage` are special here though because they don't belong to any proper category. For now I'm just calling `xpack.info` `xPackInfo()` and intend to call usage `xPackUsage` though I'm not convinced that this is the final name for them. But it does get us started. = Jars, jars everywhere! This change makes the `xpack:protocol` project a `compile` scoped dependency of the `x-pack:plugin:core` and `client:rest-high-level` projects. I intend to keep it a compile scoped dependency of `x-pack:plugin:core` but I intend to bundle the contents of the protocol jar into the `client:rest-high-level` jar in a follow up. This change has grown large enough at this point. In that followup I'll address javadoc issues as well. = Breaking-Java This breaks that transport client by a few classes around. We've traditionally been ok with doing this to the transport client.
2018-07-08 11:03:56 -04:00
* <<java-rest-high-x-pack-info>>
[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
2018-08-10 08:12:42 -04:00
* <<java-rest-high-x-pack-usage>>
[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] 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
2018-08-10 08:12:42 -04:00
include::miscellaneous/x-pack-info.asciidoc[]
include::miscellaneous/x-pack-usage.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 synced flush API (2) (#30650) Adds the synced flush API to the high level REST client. Relates to #27205.
2018-05-30 07:32:52 -04:00
* <<java-rest-high-flush-synced>>
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>>
Add Get Settings API support to java high-level rest client (#29229) This PR adds support for the Get Settings API to the java high-level rest client. Furthermore, logic related to the retrieval of default settings has been moved from the rest layer into the transport layer and now default settings may be retrieved consistency via both the rest API and the transport API.
2018-05-04 11:14:28 -04:00
* <<java-rest-high-get-settings>>
REST high-level client: add validate query API (#31077) Adds the validate query API to the high level rest client.
2018-06-18 09:59:29 -04:00
* <<java-rest-high-indices-validate-query>>
REST high-level client: add get index API (#31703) Also added master_timeout parameter for the indices.get spec Relates to #27205
2018-07-05 13:52:25 -04:00
* <<java-rest-high-get-index>>
[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>>
[DOCS] Add missing get mappings docs to HLRC (#31765) This commit adds the high-level rest client docs for the get mappings API that was added in #30889
2018-07-03 19:10:52 -04:00
* <<java-rest-high-get-mappings>>
Add get field mappings to High Level REST API Client (#31423) Add get field mappings to High Level REST API Client Relates to #27205
2018-06-23 03:39:17 -04:00
* <<java-rest-high-get-field-mappings>>
[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
Alias Management::
* <<java-rest-high-update-aliases>>
* <<java-rest-high-exists-alias>>
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
* <<java-rest-high-get-alias>>
[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 analyze API to high-level rest client (#31577)
2018-07-03 10:57:02 -04:00
include::indices/analyze.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/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 synced flush API (2) (#30650) Adds the synced flush API to the high level REST client. Relates to #27205.
2018-05-30 07:32:52 -04:00
include::indices/flush_synced.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[]
Add get mappings support to high-level rest client (#30889) This adds support for the get mappings API to the high level rest client. Relates to #27205
2018-06-04 16:31:08 -04:00
include::indices/get_mappings.asciidoc[]
Add get field mappings to High Level REST API Client (#31423) Add get field mappings to High Level REST API Client Relates to #27205
2018-06-23 03:39:17 -04:00
include::indices/get_field_mappings.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/update_aliases.asciidoc[]
include::indices/exists_alias.asciidoc[]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
include::indices/get_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[]
Add Get Settings API support to java high-level rest client (#29229) This PR adds support for the Get Settings API to the java high-level rest client. Furthermore, logic related to the retrieval of default settings has been moved from the rest layer into the transport layer and now default settings may be retrieved consistency via both the rest API and the transport API.
2018-05-04 11:14:28 -04:00
include::indices/get_settings.asciidoc[]
Add put index template api to high level rest client (#30400) Relates #27205
2018-05-06 09:47:36 -04:00
include::indices/put_template.asciidoc[]
REST high-level client: add validate query API (#31077) Adds the validate query API to the high level rest client.
2018-06-18 09:59:29 -04:00
include::indices/validate_query.asciidoc[]
HLRest: Add get index templates API (#31161) Relates #27205
2018-06-11 11:06:28 -04:00
include::indices/get_templates.asciidoc[]
REST high-level client: add get index API (#31703) Also added master_timeout parameter for the indices.get spec Relates to #27205
2018-07-05 13:52:25 -04:00
include::indices/get_index.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>>
rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
* <<java-rest-high-cluster-get-settings>>
REST high-level client: add Cluster Health API (#29331) Relates to #27205
2018-06-12 07:34:06 -04:00
* <<java-rest-high-cluster-health>>
Add Cluster Put Settings API to the high level REST client (#28633) Relates to #27205
2018-02-15 11:21:45 -05:00
include::cluster/put_settings.asciidoc[]
rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
include::cluster/get_settings.asciidoc[]
REST high-level client: add Cluster Health API (#29331) Relates to #27205
2018-06-12 07:34:06 -04:00
include::cluster/health.asciidoc[]
Move pipeline APIs to ingest namespace (#31027)
2018-06-04 04:34:55 -04:00
== Ingest APIs
The Java High Level REST Client supports the following Ingest APIs:
* <<java-rest-high-ingest-put-pipeline>>
* <<java-rest-high-ingest-get-pipeline>>
* <<java-rest-high-ingest-delete-pipeline>>
REST high-level client: add simulate pipeline API (#31158) relates to #27205
2018-06-22 03:59:04 -04:00
* <<java-rest-high-ingest-simulate-pipeline>>
Move pipeline APIs to ingest namespace (#31027)
2018-06-04 04:34:55 -04:00
include::ingest/put_pipeline.asciidoc[]
include::ingest/get_pipeline.asciidoc[]
include::ingest/delete_pipeline.asciidoc[]
REST high-level client: add simulate pipeline API (#31158) relates to #27205
2018-06-22 03:59:04 -04:00
include::ingest/simulate_pipeline.asciidoc[]
Add GET Repository High Level REST API (#30362) This commit adds the Snapshot Client with a first API call within it, the get repositories call in snapshot/restore module. This also creates a snapshot namespace for the docs, as well as get repositories docs. Relates #27205
2018-05-09 08:25:23 -04:00
== Snapshot APIs
The Java High Level REST Client supports the following Snapshot APIs:
* <<java-rest-high-snapshot-get-repository>>
Add Delete Repository High Level REST API (#30666) This commit adds Delete Repository, the associated docs and tests for the high level REST API client. It also cleans up a seemingly innocuous line in the RestDeleteRepositoryAction and some naming in SnapshotIT. Relates #27205
2018-05-21 20:52:21 -04:00
* <<java-rest-high-snapshot-create-repository>>
* <<java-rest-high-snapshot-delete-repository>>
Add Verify Repository High Level REST API (#30934) This commit adds Verify Repository, the associated docs and tests for the high level REST API client. A few small changes to the Verify Repository Response went into the commit as well. Relates #27205
2018-05-30 12:10:00 -04:00
* <<java-rest-high-snapshot-verify-repository>>
Add Create Snapshot to High-Level Rest Client (#31215) Added support to the high-level rest client for the create snapshot API call. This required several changes to toXContent which may need to be cleaned up in a later PR. Also added several parsers for fromXContent to be able to retrieve appropriate responses along with tests.
2018-06-27 12:30:10 -04:00
* <<java-rest-high-snapshot-create-snapshot>>
Add Get Snapshots High Level REST API (#31537) With this commit we add the get snapshots API to the Java high level REST client. Relates #27205
2018-06-27 20:04:34 -04:00
* <<java-rest-high-snapshot-get-snapshots>>
Add Snapshots Status API to High Level Rest Client (#31515) This PR adds the Snapshots Status API to the Snapshot Client, as well as additional documentation for the status api.
2018-07-11 12:07:31 -04:00
* <<java-rest-high-snapshot-snapshots-status>>
Add Delete Snapshot High Level REST API With this commit we add the delete snapshot API to the Java high level REST client. Relates #27205 Relates #31393
2018-06-20 10:42:50 -04:00
* <<java-rest-high-snapshot-delete-snapshot>>
Add GET Repository High Level REST API (#30362) This commit adds the Snapshot Client with a first API call within it, the get repositories call in snapshot/restore module. This also creates a snapshot namespace for the docs, as well as get repositories docs. Relates #27205
2018-05-09 08:25:23 -04:00
Add Create Repository High Level REST API (#30501) This commit adds Create Repository, the associated docs and tests for the high level REST API client. A few small changes to the PutRepository Request and Response went into the commit as well.
2018-05-15 22:21:11 -04:00
include::snapshot/get_repository.asciidoc[]
Rest High Level client: Add List Tasks (#29546) This change adds a `listTasks` method to the high level java ClusterClient which allows listing running tasks through the task management API. Related to #27205
2018-05-16 07:31:37 -04:00
include::snapshot/create_repository.asciidoc[]
Add Delete Repository High Level REST API (#30666) This commit adds Delete Repository, the associated docs and tests for the high level REST API client. It also cleans up a seemingly innocuous line in the RestDeleteRepositoryAction and some naming in SnapshotIT. Relates #27205
2018-05-21 20:52:21 -04:00
include::snapshot/delete_repository.asciidoc[]
Add Verify Repository High Level REST API (#30934) This commit adds Verify Repository, the associated docs and tests for the high level REST API client. A few small changes to the Verify Repository Response went into the commit as well. Relates #27205
2018-05-30 12:10:00 -04:00
include::snapshot/verify_repository.asciidoc[]
Add Create Snapshot to High-Level Rest Client (#31215) Added support to the high-level rest client for the create snapshot API call. This required several changes to toXContent which may need to be cleaned up in a later PR. Also added several parsers for fromXContent to be able to retrieve appropriate responses along with tests.
2018-06-27 12:30:10 -04:00
include::snapshot/create_snapshot.asciidoc[]
Add Get Snapshots High Level REST API (#31537) With this commit we add the get snapshots API to the Java high level REST client. Relates #27205
2018-06-27 20:04:34 -04:00
include::snapshot/get_snapshots.asciidoc[]
Add Snapshots Status API to High Level Rest Client (#31515) This PR adds the Snapshots Status API to the Snapshot Client, as well as additional documentation for the status api.
2018-07-11 12:07:31 -04:00
include::snapshot/snapshots_status.asciidoc[]
Add Delete Snapshot High Level REST API With this commit we add the delete snapshot API to the Java high level REST client. Relates #27205 Relates #31393
2018-06-20 10:42:50 -04:00
include::snapshot/delete_snapshot.asciidoc[]
Move list tasks under Tasks namespace (#30906) Our API spec define the tasks API as e.g. tasks.list, meaning that they belong to their own namespace. This commit moves them from the cluster namespace to their own namespace. Relates to #29546
2018-05-29 04:54:41 -04:00
== Tasks APIs
The Java High Level REST Client supports the following Tasks APIs:
* <<java-rest-high-tasks-list>>
high level REST api: cancel task (#30745) * Initial commit of rest high level exposure of cancel task * fix javadocs * address some code review comments * update branch to use tasks namespace instead of cluster * High-level client: list tasks failure to not lose nodeId This commit reworks testing for `ListTasksResponse` so that random fields insertion can be tested and xcontent equivalence can be checked too. Proper exclusions need to be configured, and failures need to be tested separately. This helped finding a little problem, whenever there is a node failure returned, the nodeId was lost as it was never printed out as part of the exception toXContent. * added comment * merge from master * re-work CancelTasksResponseTests to separate XContent failure cases from non-failure cases * remove duplication of logic in parser creation * code review changes * refactor TasksClient to support RequestOptions * add tests for parent task id * address final PR review comments, mostly formatting and such
2018-06-07 17:02:23 -04:00
* <<java-rest-high-cluster-cancel-tasks>>
Move list tasks under Tasks namespace (#30906) Our API spec define the tasks API as e.g. tasks.list, meaning that they belong to their own namespace. This commit moves them from the cluster namespace to their own namespace. Relates to #29546
2018-05-29 04:54:41 -04:00
include::tasks/list_tasks.asciidoc[]
high level REST api: cancel task (#30745) * Initial commit of rest high level exposure of cancel task * fix javadocs * address some code review comments * update branch to use tasks namespace instead of cluster * High-level client: list tasks failure to not lose nodeId This commit reworks testing for `ListTasksResponse` so that random fields insertion can be tested and xcontent equivalence can be checked too. Proper exclusions need to be configured, and failures need to be tested separately. This helped finding a little problem, whenever there is a node failure returned, the nodeId was lost as it was never printed out as part of the exception toXContent. * added comment * merge from master * re-work CancelTasksResponseTests to separate XContent failure cases from non-failure cases * remove duplication of logic in parser creation * code review changes * refactor TasksClient to support RequestOptions * add tests for parent task id * address final PR review comments, mostly formatting and such
2018-06-07 17:02:23 -04:00
include::tasks/cancel_tasks.asciidoc[]
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
2018-06-19 08:21:11 -04:00
== Script APIs
The Java High Level REST Client supports the following Scripts APIs:
* <<java-rest-high-get-stored-script>>
HLRC: Add put stored script support to high-level rest client (#31323) Relates to #27205
2018-09-09 07:47:47 -04:00
* <<java-rest-high-put-stored-script>>
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
2018-06-19 08:21:11 -04:00
* <<java-rest-high-delete-stored-script>>
include::script/get_script.asciidoc[]
HLRC: Add put stored script support to high-level rest client (#31323) Relates to #27205
2018-09-09 07:47:47 -04:00
include::script/put_script.asciidoc[]
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
2018-06-19 08:21:11 -04:00
include::script/delete_script.asciidoc[]
Rest HL client: Add put license action (#32214) In the HL REST client we replace the License object with a string, because of complexity of this class. It is also not really needed on the client side since end-users are not interacting with the license besides passing it as a string to the server. Relates #29827
2018-07-24 14:19:07 -04:00
== Licensing APIs
The Java High Level REST Client supports the following Licensing APIs:
* <<java-rest-high-put-license>>
[DOCS] Add missing link to get license API docs (#32746)
2018-08-10 04:55:25 -04:00
* <<java-rest-high-get-license>>
HLRC: Add Delete License API (#32586) Relates to #29827
2018-08-14 05:55:54 -04:00
* <<java-rest-high-delete-license>>
Rest HL client: Add put license action (#32214) In the HL REST client we replace the License object with a string, because of complexity of this class. It is also not really needed on the client side since end-users are not interacting with the license besides passing it as a string to the server. Relates #29827
2018-07-24 14:19:07 -04:00
include::licensing/put-license.asciidoc[]
[DOCS] Add missing link to get license API docs (#32746)
2018-08-10 04:55:25 -04:00
include::licensing/get-license.asciidoc[]
HLRC: Add Delete License API (#32586) Relates to #29827
2018-08-14 05:55:54 -04:00
include::licensing/delete-license.asciidoc[]
[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
2018-08-10 08:12:42 -04:00
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
== Machine Learning APIs
The Java High Level REST Client supports the following Machine Learning APIs:
* <<java-rest-high-x-pack-ml-put-job>>
HLRC: Add ML Get Job (#32960) * HLRC: Adding GET ML Job info API * HLRC: Adding GET Job ML API * Fixing QueryPage license header * Adding serialization tests, addressing minor issues * Renaming querypage, changing the dependency on it * Making things immutable * Fixing build failure due to method rename
2018-08-21 22:02:28 -04:00
* <<java-rest-high-x-pack-ml-get-job>>
HLRC: adding machine learning delete job (#32820) * HLRC: adding machine learning delete job * Fixing whitespace * Moving docs and tests around * Unifying ml asciidoc file naming convention
2018-08-16 08:18:43 -04:00
* <<java-rest-high-x-pack-ml-delete-job>>
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
* <<java-rest-high-x-pack-ml-open-job>>
HLRC: ML Close Job (#32943) * HLRC: Adding ML Close Job API HLRC: Adding ML Close Job API * reconciling request converters * Adding serialization tests and addressing PR comments * Changing constructor order
2018-08-20 17:05:56 -04:00
* <<java-rest-high-x-pack-ml-close-job>>
HLRC: ML Flush job (#33187) * HLRC: ML Flush job * Fixing package, paths, and test * Addressing comments
2018-09-01 17:01:23 -04:00
* <<java-rest-high-x-pack-ml-flush-job>>
HLRC: ML Update Job (#33392) * HLRC: ML Update Job
2018-09-06 08:18:09 -04:00
* <<java-rest-high-x-pack-ml-update-job>>
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
* <<java-rest-high-x-pack-ml-get-job-stats>>
HLRC: ML Forecast Job (#33506) * HLRC: ML Forecast job
2018-09-07 12:16:58 -04:00
* <<java-rest-high-x-pack-ml-forecast-job>>
HLRC: Add ML Get Buckets API (#33056) Relates #29827
2018-08-23 04:35:06 -04:00
* <<java-rest-high-x-pack-ml-get-buckets>>
HLRC: Add ML get overall buckets API (#33297) Relates #29827
2018-09-03 08:34:36 -04:00
* <<java-rest-high-x-pack-ml-get-overall-buckets>>
HLRC: Add ML Get Records API (#33085) Relates #29827
2018-08-29 10:03:58 -04:00
* <<java-rest-high-x-pack-ml-get-records>>
HLRC: ML Post Data (#33443) * HLRC: ML Post data
2018-09-07 08:04:27 -04:00
* <<java-rest-high-x-pack-ml-post-data>>
HLRC: Add ML get influencers API (#33389) Relates #29827
2018-09-05 10:06:55 -04:00
* <<java-rest-high-x-pack-ml-get-influencers>>
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
include::ml/put-job.asciidoc[]
HLRC: Add ML Get Job (#32960) * HLRC: Adding GET ML Job info API * HLRC: Adding GET Job ML API * Fixing QueryPage license header * Adding serialization tests, addressing minor issues * Renaming querypage, changing the dependency on it * Making things immutable * Fixing build failure due to method rename
2018-08-21 22:02:28 -04:00
include::ml/get-job.asciidoc[]
HLRC: adding machine learning delete job (#32820) * HLRC: adding machine learning delete job * Fixing whitespace * Moving docs and tests around * Unifying ml asciidoc file naming convention
2018-08-16 08:18:43 -04:00
include::ml/delete-job.asciidoc[]
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
include::ml/open-job.asciidoc[]
HLRC: ML Close Job (#32943) * HLRC: Adding ML Close Job API HLRC: Adding ML Close Job API * reconciling request converters * Adding serialization tests and addressing PR comments * Changing constructor order
2018-08-20 17:05:56 -04:00
include::ml/close-job.asciidoc[]
HLRC: ML Update Job (#33392) * HLRC: ML Update Job
2018-09-06 08:18:09 -04:00
include::ml/update-job.asciidoc[]
HLRC: ML Flush job (#33187) * HLRC: ML Flush job * Fixing package, paths, and test * Addressing comments
2018-09-01 17:01:23 -04:00
include::ml/flush-job.asciidoc[]
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
include::ml/get-job-stats.asciidoc[]
HLRC: ML Forecast Job (#33506) * HLRC: ML Forecast job
2018-09-07 12:16:58 -04:00
include::ml/forecast-job.asciidoc[]
HLRC: Add ML Get Buckets API (#33056) Relates #29827
2018-08-23 04:35:06 -04:00
include::ml/get-buckets.asciidoc[]
HLRC: Add ML get overall buckets API (#33297) Relates #29827
2018-09-03 08:34:36 -04:00
include::ml/get-overall-buckets.asciidoc[]
HLRC: Add ML Get Records API (#33085) Relates #29827
2018-08-29 10:03:58 -04:00
include::ml/get-records.asciidoc[]
HLRC: ML Post Data (#33443) * HLRC: ML Post data
2018-09-07 08:04:27 -04:00
include::ml/post-data.asciidoc[]
HLRC: Add ML get influencers API (#33389) Relates #29827
2018-09-05 10:06:55 -04:00
include::ml/get-influencers.asciidoc[]
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
HLRC: migration get assistance API (#32744) The request and response classes have been extracted from `IndexUpgradeInfoAction` into top-level classes, and moved to the protocol jar. The `UpgradeActionRequired` enum is also moved. Relates to #29827
2018-08-13 05:05:27 -04:00
== Migration APIs
The Java High Level REST Client supports the following Migration APIs:
* <<java-rest-high-migration-get-assistance>>
include::migration/get-assistance.asciidoc[]
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
== Security APIs
The Java High Level REST Client supports the following Security APIs:
* <<java-rest-high-security-put-user>>
* <<java-rest-high-security-enable-user>>
* <<java-rest-high-security-disable-user>>
include::security/put-user.asciidoc[]
include::security/enable-user.asciidoc[]
include::security/disable-user.asciidoc[]
[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
2018-08-10 08:12:42 -04:00
== Watcher APIs
The Java High Level REST Client supports the following Watcher APIs:
* <<java-rest-high-x-pack-watcher-put-watch>>
* <<java-rest-high-x-pack-watcher-delete-watch>>
include::watcher/put-watch.asciidoc[]
include::watcher/delete-watch.asciidoc[]
HLRC GraphClient and associated tests (#32366) GraphClient for the high level REST client and associated tests. Part of #29827 work
2018-08-21 08:29:18 -04:00
== Graph APIs
The Java High Level REST Client supports the following Graph APIs:
* <<java-rest-high-x-pack-graph-explore>>
include::graph/explore.asciidoc[]