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

Stored script related docs of Java API are outdated #28144

Closed
danielmitterdorfer opened this issue Jan 9, 2018 · 5 comments
Closed

Stored script related docs of Java API are outdated #28144

danielmitterdorfer opened this issue Jan 9, 2018 · 5 comments
Assignees
Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache :Core/Infra/Transport API Transport client API >docs General docs changes good first issue low hanging fruit

Comments

@danielmitterdorfer
Copy link
Member

Originally reported in #28114:

  1. PutIndexedScriptResponse, GetIndexedScriptResponse, and DeleteIndexedScriptResponse are outdated in https://www.elastic.co/guide/en/elasticsearch/client/java-api/master/indexed-scripts.html

    PutIndexedScriptResponse = client.preparePutIndexedScript()...

    GetIndexedScriptResponse = client.prepareGetIndexedScript()...

    DeleteIndexedScriptResponse = client.prepareDeleteIndexedScript()...

These are leftovers from #17650 and all *IndexedScript* should be replaced by *StoredScript* if I understood the change correctly (e.g. PutIndexedScriptResponse -> PutStoredScriptResponse, client.preparePutIndexedScript() -> client.preparePutStoredScript()).

@martijnvg I hope it's ok I'm assigning it to you as you did the change and might remember best.

@martijnvg
Copy link
Member

These are leftovers from #17650 and all IndexedScript should be replaced by StoredScript if I understood the change correctly (e.g. PutIndexedScriptResponse -> PutStoredScriptResponse, client.preparePutIndexedScript() -> client.preparePutStoredScript()).

@danielmitterdorfer That is correct. I'll will update these docs.

@ankishagarwal
Copy link

@martijnvg the docs are still showing outdated content for release version 5.1
Link -> https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.1/indexed-scripts.html

@martijnvg
Copy link
Member

@ankishagarwal If I recall correctly for 5.x, only the docs for 5.6 have been updated. Most of the times if doc changes are backported to 5.x, the changes are only backported to 5.6, since that is the only 5.x version that is maintained.

@ankishagarwal
Copy link

The docs of release 5.6 is similar to 5.1 i.e outdated.

It asks user to use classes PutIndexedScriptResponse, GetIndexedScriptResponse , and DeleteIndexedScriptResponse rather than asking for PutStoredScriptResponse ,etc.

@martijnvg
Copy link
Member

I was mistaken this doc change was only backported to 6.0, so I backported it to 5.6 branch. This should be visible soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache :Core/Infra/Transport API Transport client API >docs General docs changes good first issue low hanging fruit
Projects
None yet
Development

No branches or pull requests

3 participants