Deprecate local parameter for get field mapping request #55014
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ywangd
added
:Data Management/Indices APIs
|
Pinging @elastic/es-core-features (:Core/Features/Indices APIs) |
martijnvg
reviewed
Apr 9, 2020
| if (request.hasParam("local")) { | ||
| deprecationLogger.deprecatedAndMaybeLog("get_field_mapping_local", | ||
| "Use [local] in get field mapping requests is deprecated." | ||
| + "The parameter will be removed in the next major version"); |
There was a problem hiding this comment.
Maybe add a space between the two sentences?
martijnvg
approved these changes
Apr 9, 2020
| deprecated:[7.8.0, Field mappings are always retrieved locally] | ||
| (Optional, boolean) If `true`, the request retrieves information from the local | ||
| node only. Defaults to `false`, which means information is retrieved from | ||
| the master node. |
There was a problem hiding this comment.
I would add that the parameter currently is just a noop.
Can you also update the migrate_7_8.asciidoc file when backporting this change to the 7.x branch?
There was a problem hiding this comment.
Added. Thanks for the heads up about the migrate doc. Will do for 7.x.
| @@ -705,11 +707,12 @@ public void testGetFieldMapping() throws IOException, InterruptedException { | |||
| request.local(true); // <1> | |||
| // end::get-field-mappings-request-local | |||
|
|
|||
| { | |||
| final RequestOptions requestOptions = RequestOptions.DEFAULT.toBuilder().setWarningsHandler(WarningsHandler.PERMISSIVE).build(); | |||
There was a problem hiding this comment.
Followed your suggestion to add deprecated annotation to GetFieldMappingsRequest#local(..) methods and removed it from the conversion. It works better and this change to RequestOptions is no longer necessary.
| node_selector: | ||
| version: "7.8.0 - " | ||
| warnings: | ||
| - "Use [local] in get field mapping requests is deprecated.The parameter will be removed in the next major version" |
There was a problem hiding this comment.
I think a space would need to be added here, otherwise this test will fail.
There was a problem hiding this comment.
Good catch. It indeed failed for many of the CI tests ...
ywangd
added a commit
to ywangd/elasticsearch
that referenced
this pull request
Apr 12, 2020
The usage of local parameter for GetFieldMappingRequest has been removed from the underlying transport action since v2.0. This PR deprecates the parameter from rest layer. It will be removed in next major version.
|
Backported:
|
russcam
added a commit
to russcam/elasticsearch
that referenced
this pull request
May 28, 2020
Relates: elastic#55014 This commit deprecates the local param in get_mapping.json. This parameter is a no-op and field mappings are always retrieved locally.
russcam
added a commit
that referenced
this pull request
May 29, 2020
Relates: #55014 This commit deprecates the local param in get_mapping.json. This parameter is a no-op and field mappings are always retrieved locally.
russcam
added a commit
that referenced
this pull request
May 29, 2020
nielsbauman
added a commit
to nielsbauman/elasticsearch
that referenced
this pull request
Feb 19, 2025
The `local` param for the `GetFieldMapping` API was deprecated in elastic#55014 and I think elastic#57265 aimed to propogate that deprecation to the REST API spec, but it changed `get_mapping.json` instead of `get_field_mapping.json`. elastic#55100 removed the `local` param for the _field_ mapping API so we can safely remove the field from the spec and remove the YAML test.
nielsbauman
added a commit
that referenced
this pull request
Feb 19, 2025
The `local` param for the `GetFieldMapping` API was deprecated in #55014 and I think #57265 aimed to propogate that deprecation to the REST API spec, but it changed `get_mapping.json` instead of `get_field_mapping.json`. #55100 removed the `local` param for the _field_ mapping API so we can safely remove the field from the spec and remove the YAML test.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The usage of
localparameter for GetFieldMappingRequest has been removed from the underlying transport action since v2.0.This PR deprecate the parameter from rest layer. It will be removed in next major version.