Deprecate `_source_include` and `_source_exclude` url parameters #33475

lipsill · 2018-09-06T17:01:47Z

Relates to #22792

elasticmachine · 2018-09-06T19:24:07Z

Pinging @elastic/es-search-aggs

nik9000

I left something minor but this seems like the right way to do it to me.

Can anyone from @elastic/es-clients comment on the changes to the rest-api-spec?

nik9000 · 2018-09-06T19:25:53Z

server/src/main/java/org/elasticsearch/search/fetch/subphase/FetchSourceContext.java

-        sIncludes = request.param("_source_include", sIncludes);
+        String sInclude = request.param("_source_include");
+        if (sInclude != null) {
+            DEPRECATION_LOGGER.deprecated("Deprecated field [_source_include] used, expected [_source_includes] instead");


What about replacing "field" with "parameter"?

nik9000 · 2018-09-06T19:29:47Z

I labelled this Search/Search because I figured that it is mostly about the search API. There are a few indices APIs that it effects as well though.

nik9000 · 2018-09-06T19:29:58Z

@elasticmachine, test this please

`source_excludes` the deprecation message refers to `parameter` instead of `field`

lipsill · 2018-09-07T10:14:46Z

rest-api-spec/src/main/resources/rest-api-spec/test/get/70_source_filtering.yml

+"Deprecated _source_include and _source_exclude":
+
+  - skip:
+      version: " - 6.4.99"


// TODO consider changing the version (if needed) once the clients specs are changed to _source_includes & _source_excludes

I'd use 6.99.99 for now. After I merge this I'll backport it to the 6.x branch. Then I'll come in and update the range here to include the backport target version.

I'm fairly sure this is what caused the build to fail. If you crack open the PR build's full console it'll have a REPRODUCE WITH line that should reproduce the failure. And I'm fairly sure switching this to 6.99.99 will make it go away.

lipsill · 2018-09-07T10:24:07Z

@nik9000 thanks for the review! And starting the CI. I wonder why the high level REST client tests passed though. I guess I can look into this next ;)

Should I assume that this PR will stay on hold until the clients change their specs?

nik9000 · 2018-09-07T12:40:29Z

@nik9000 thanks for the review! And starting the CI. I wonder why the high level REST client tests passed though. I guess I can look into this next ;)

I'm happy to do it! Why the tests passed is a good question. If they are ignoring deprecation messages that'd be bad but a problem for another PR. Happy hunting!

Should I assume that this PR will stay on hold until the clients change their specs?

They won't need to change their specs but they might need to do something. I'm not sure what. The .NET client generates things from these files.

…clude

_source_excludes params

lipsill · 2018-10-26T09:31:01Z

@nik9000 I just updated the PR to include the the strict deprecation mode and resolve the conflicts.
I was gonna ask somebody to trigger the CI, but it started by itself 😇

nik9000

I left a request to change the line that I think caused the build to fail.

nik9000 · 2018-10-26T13:00:22Z

rest-api-spec/src/main/resources/rest-api-spec/test/get/70_source_filtering.yml

+"Deprecated _source_include and _source_exclude":
+
+  - skip:
+      version: " - 6.4.99"


I'd use 6.99.99 for now. After I merge this I'll backport it to the 6.x branch. Then I'll come in and update the range here to include the backport target version.

I'm fairly sure this is what caused the build to fail. If you crack open the PR build's full console it'll have a REPRODUCE WITH line that should reproduce the failure. And I'm fairly sure switching this to 6.99.99 will make it go away.

nik9000 · 2018-10-26T13:05:43Z

Thanks for updating this @lipsill! I think it is super close. Hopefully the REPRODUCE WITH line in the build failure will let you reproduce the issue so it isn't too bad to fix. Thanks again!

lipsill · 2018-10-26T16:42:34Z

@nik9000 thanks for the tip work around the issue;)

Can you trigger another CI when you have the chance?

nik9000 · 2018-10-26T17:10:46Z

@elasticmachine, test this please

) Deprecates `_source_include` and `_source_exclude` url parameters in favor of `_source_inclues` and `_source_excludes` because those are consistent with the rest of Elasticsearch's APIs. Relates to #22792

nik9000 · 2018-10-29T19:51:02Z

@lipsill all merged and backported! Thanks so much for this!

) Deprecates `_source_include` and `_source_exclude` url parameters in favor of `_source_inclues` and `_source_excludes` because those are consistent with the rest of Elasticsearch's APIs. Relates to #22792

Update the test for the deprecated `_source_exclude` parameter to run against 6.6.0+ now that we've backported the deprecation. Relates to #33475

…de` (#35097) Removes `_source_include` and `_source_exclude` url parameters. These parameters have been deprecated in #33475. Closes #22792

Mpdreamz · 2019-01-31T14:41:47Z

This did end up biting us @nik9000 thank you for the ping though, not sure how it got lost on my end.

Deprecate _source_include and _source_exclude url parameters

698d290

nik9000 added the :Search/Search Search-related issues that do not fall into other categories label Sep 6, 2018

nik9000 added v7.0.0 v6.5.0 >deprecation labels Sep 6, 2018

nik9000 reviewed Sep 6, 2018

View reviewed changes

modify the high level rest client to use _source_includes and

5804286

`source_excludes` the deprecation message refers to `parameter` instead of `field`

lipsill commented Sep 7, 2018

View reviewed changes

colings86 added v6.6.0 and removed v6.5.0 labels Oct 25, 2018

lipsill added 2 commits October 26, 2018 10:59

Merge remote-tracking branch 'origin/master' into deprecate_source_in…

ffec285

…clude

modify the newly added test cases to use _source_includes and

23d2a0d

_source_excludes params

nik9000 requested changes Oct 26, 2018

View reviewed changes

set skip version to 6.99.99

7f91492

nik9000 approved these changes Oct 26, 2018

View reviewed changes

nik9000 merged commit 6df1c9e into elastic:master Oct 29, 2018

nik9000 added the backport pending label Oct 29, 2018

nik9000 removed the backport pending label Oct 29, 2018

nik9000 added a commit that referenced this pull request Oct 30, 2018

Search: Test deprecated field in mixed cluster

590fd21

Update the test for the deprecated `_source_exclude` parameter to run against 6.6.0+ now that we've backported the deprecation. Relates to #33475

nik9000 added a commit that referenced this pull request Oct 30, 2018

Search: Test deprecated field in mixed cluster

70e939e

Update the test for the deprecated `_source_exclude` parameter to run against 6.6.0+ now that we've backported the deprecation. Relates to #33475

lipsill mentioned this pull request Oct 30, 2018

Remove deprecated url parameters _source_include and _source_exclude #35097

Merged

nik9000 pushed a commit that referenced this pull request Oct 31, 2018

Remove deprecated url parameters _source_include and `_source_exclu…

d181d1b

…de` (#35097) Removes `_source_include` and `_source_exclude` url parameters. These parameters have been deprecated in #33475. Closes #22792

codebrain mentioned this pull request Jan 25, 2019

[meta] 6.6.0 Release elastic/elasticsearch-net#3552

Closed

48 tasks

Mpdreamz mentioned this pull request Jan 31, 2019

Deprecation process for the rest spec #38102

Closed

jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

delvedor mentioned this pull request May 15, 2019

Patch deprecated parameters elastic/elasticsearch-js#851

Merged

delvedor added a commit to delvedor/elasticsearch that referenced this pull request May 16, 2019

Remove deprecated parameters (follow-up elastic#33475)

1f2fcae

delvedor mentioned this pull request May 16, 2019

Remove deprecated _source_exclude and _source_include from get API spec #42188

Merged

adiloztaser mentioned this pull request May 12, 2020

Deprecated field [include] used, expected [includes] instead 10up/ElasticPress#1769

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `_source_include` and `_source_exclude` url parameters #33475

Deprecate `_source_include` and `_source_exclude` url parameters #33475

lipsill commented Sep 6, 2018

elasticmachine commented Sep 6, 2018

nik9000 left a comment

nik9000 Sep 6, 2018

nik9000 commented Sep 6, 2018

nik9000 commented Sep 6, 2018

lipsill Sep 7, 2018

nik9000 Oct 26, 2018

lipsill commented Sep 7, 2018

nik9000 commented Sep 7, 2018

lipsill commented Oct 26, 2018

nik9000 left a comment

nik9000 Oct 26, 2018

nik9000 commented Oct 26, 2018

lipsill commented Oct 26, 2018

nik9000 commented Oct 26, 2018

nik9000 commented Oct 29, 2018

Mpdreamz commented Jan 31, 2019

Deprecate _source_include and _source_exclude url parameters #33475

Deprecate _source_include and _source_exclude url parameters #33475

Conversation

lipsill commented Sep 6, 2018

elasticmachine commented Sep 6, 2018

nik9000 left a comment

Choose a reason for hiding this comment

nik9000 Sep 6, 2018

Choose a reason for hiding this comment

nik9000 commented Sep 6, 2018

nik9000 commented Sep 6, 2018

lipsill Sep 7, 2018

Choose a reason for hiding this comment

nik9000 Oct 26, 2018

Choose a reason for hiding this comment

lipsill commented Sep 7, 2018

nik9000 commented Sep 7, 2018

lipsill commented Oct 26, 2018

nik9000 left a comment

Choose a reason for hiding this comment

nik9000 Oct 26, 2018

Choose a reason for hiding this comment

nik9000 commented Oct 26, 2018

lipsill commented Oct 26, 2018

nik9000 commented Oct 26, 2018

nik9000 commented Oct 29, 2018

Mpdreamz commented Jan 31, 2019

Deprecate `_source_include` and `_source_exclude` url parameters #33475

Deprecate `_source_include` and `_source_exclude` url parameters #33475