Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] High-level REST client : incomplete docs #31499

Closed
olcbean opened this issue Jun 21, 2018 · 2 comments · Fixed by #51850
Closed

[docs] High-level REST client : incomplete docs #31499

olcbean opened this issue Jun 21, 2018 · 2 comments · Fixed by #51850
Labels
>docs General docs changes help wanted adoptme

Comments

@olcbean
Copy link
Contributor

olcbean commented Jun 21, 2018

In the high level REST client, a client specific response has been create for the get alias API that holds not only the aliases but also an error message, an exception and the status as part of the response.

For this API the rest client always returns a response ( even when an exception occurs, it is parsed and set in the response ). Should the docs be extended and clarify that the users should analyze the response in order to determine if an exception has occurred on the server or not?

Currently the docs refer only to the aliases :

[[java-rest-high-get-alias-response]]
==== Get Alias Response
The returned `GetAliasesResponse` allows to retrieve information about the
executed operation as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[get-alias-response]
--------------------------------------------------
<1> Retrieves a map of indices and their aliases
// tag::get-alias-response
Map<String, Set<AliasMetaData>> aliases = response.getAliases(); // <1>
// end::get-alias-response


#30536 : discusses the current get aliases API
#28799 : added the get aliases API to the high level REST client and introduced the client specific response

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@javanna javanna added the help wanted adoptme label Jun 21, 2018
@debadair
Copy link
Contributor

[doc-issue-triage]

timoninmaxim added a commit to timoninmaxim/elasticsearch that referenced this issue Feb 9, 2020
probakowski pushed a commit that referenced this issue Feb 24, 2020
probakowski pushed a commit to probakowski/elasticsearch that referenced this issue Feb 24, 2020
probakowski added a commit that referenced this issue Feb 24, 2020
Closes #31499

Co-authored-by: Maxim <timonin.maksim@mail.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes help wanted adoptme
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants