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

[HLRC] Documentation examples cleanup #34009

Merged
merged 5 commits into from
Oct 16, 2018
Merged

Conversation

lipsill
Copy link
Contributor

@lipsill lipsill commented Sep 24, 2018

While digging into something else I noticed that there are several WARN messages in the high-level REST client integration tests. And most of them are caused by examples in the documentation that use deprecated functionality (i.e. specifying type in _search requests). While the high level rest client should support the 'deprecated' functionality, I think that the client's documentation must not cover such examples.

This PR modifies the examples so that there are no deprecation warnings. The changes are grouped in separate commits, so it is easy to pick and choose the changes that should be adopted.

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@tlrx tlrx added the >docs General docs changes label Sep 25, 2018
@javanna
Copy link
Member

javanna commented Oct 3, 2018

this may be outdated with recent changes, @nik9000 can you have a look please?

@javanna javanna requested a review from nik9000 October 3, 2018 08:33
@nik9000
Copy link
Member

nik9000 commented Oct 4, 2018

I'm not following along with the types removal stuff super closely which is the bulk of this. @jtibshirani will probably know it better so I'm pinging her.

@original-brownbear is responsible for the ctx thing and probably should look at this too.

@jtibshirani
Copy link
Contributor

The changes around SearchRequest#types look good to me, thanks @lipsill for cleaning this up.

@nik9000
Copy link
Member

nik9000 commented Oct 16, 2018

I've merged master to fix the merge conflict that I introduced. I tested it locally. I've reached out to @original-brownbear to talk about ctx thing but regardless of how that goes this change is good. I'm gonna merge it and backport to the 6.x branch.

@nik9000 nik9000 merged commit 9b5eaaf into elastic:master Oct 16, 2018
nik9000 pushed a commit that referenced this pull request Oct 16, 2018
* Replace deprecated field `code` with `source` for stored scripts (#25127)
* Replace examples using the deprecated endpoint `{index}/{type}/_search`
with `{index}/_search` (#29468)
* Use a system property to avoid deprecation warnings after the Update
Scripts have been moved to their own context (#32096)
@nik9000
Copy link
Member

nik9000 commented Oct 16, 2018

All merged now! Thanks again @lipsill!

@lipsill lipsill deleted the hlrc_warnings branch October 17, 2018 14:39
@lipsill
Copy link
Contributor Author

lipsill commented Oct 17, 2018

Thanks everybody! Thanks @nik9000 !

kcm pushed a commit that referenced this pull request Oct 30, 2018
* Replace deprecated field `code` with `source` for stored scripts (#25127)
* Replace examples using the deprecated endpoint `{index}/{type}/_search`
with `{index}/_search` (#29468)
* Use a system property to avoid deprecation warnings after the Update
Scripts have been moved to their own context (#32096)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants