Add delete alias to the HLRC (#48819)

The delete alias call is a rest only API call, but should still be added
to the rest client. This commit adds it as well as relevant tests.

Ref #47678
This commit is contained in:
Michael Basnight 2019-11-11 16:47:22 -05:00 committed by GitHub
parent c868a11ddb
commit 7115d3e370
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 259 additions and 1 deletions

View file

@ -0,0 +1,49 @@
--
:api: delete-alias
:request: DeleteAliasRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Delete Alias API
[id="{upid}-{api}-request"]
==== Delete Alias Request
An +{request}+ requires an `index` and an `alias` argument:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
==== Optional arguments
The following arguments can optionally be provided:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-timeout]
--------------------------------------------------
<1> Timeout to wait for the all the nodes to acknowledge the index is opened
as a `TimeValue`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
--------------------------------------------------
<1> Timeout to connect to the master node as a `TimeValue`
[id="{upid}-{api}-response"]
==== Delete Alias Response
The returned +{response}+ indicates if the request to delete the alias
was received.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the request to delete the alias was
acknowledged.
include::../execution.asciidoc[]

View file

@ -120,6 +120,7 @@ Alias Management::
* <<{upid}-update-aliases>>
* <<{upid}-exists-alias>>
* <<{upid}-get-alias>>
* <<{upid}-delete-alias>>
Template Management::
* <<{upid}-get-templates>>
@ -145,6 +146,7 @@ include::indices/put_mapping.asciidoc[]
include::indices/get_mappings.asciidoc[]
include::indices/get_field_mappings.asciidoc[]
include::indices/update_aliases.asciidoc[]
include::indices/delete_alias.asciidoc[]
include::indices/exists_alias.asciidoc[]
include::indices/get_alias.asciidoc[]
include::indices/put_settings.asciidoc[]