Remove ignored type parameter in search_shards api #21688
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
javanna
added
:Search/Search
jpountz
approved these changes
Nov 20, 2016
Contributor
jpountz
left a comment
jpountz
left a comment
There was a problem hiding this comment.
LGTM. Let's add deprecation logging to 5.x as a follow-up?
Contributor
There was a problem hiding this comment.
Does it matter that requireNonNull throws a NPE rather than an IAE like before?
Member
Author
There was a problem hiding this comment.
good point. I don't think so, we were not testing this behaviour anywhere. Added a test for this now.
Contributor
There was a problem hiding this comment.
maybe leave a quick comment, eg. // types so that the reader can know what this parameter was about
javanna
force-pushed
the
enhancement/remove_types_search_shards
branch
from
9f0ee10 to
879ff34
Compare
The `type` parameter has always been accepted by the search_shards api, probably to make the api and its urls the same as search. Truth is that the type never had any effect, it's been ignored from day one while accepting it may make users think that we actually do something with it. This commit removes support for the type parameter from the REST layer and the Java API. Backwards compatibility is maintained on the transport layer though. The new added serialization test also uncovered a bug in the java API where the `ClusterSearchShardsRequest` could be created with no arguments, but the indices were required to be not null otherwise the request couldn't be serialized as `writeTo` would throw NPE. Fixed by setting a default value (empty array) for indices.
javanna
force-pushed
the
enhancement/remove_types_search_shards
branch
from
879ff34 to
4e6cbe0
Compare
Member
Author
|
retest this please |
javanna
added a commit
to javanna/elasticsearch
that referenced
this pull request
Nov 22, 2016
The `type` parameter has always been accepted by the search_shards api, probably to make the api and its urls the same as search. Truth is that the type never had any effect, it's been ignored from day one while accepting it may make users think that we actually do something with it. This commit deprecate support for the type parameter from the REST layer and removes it from the Java API. Backwards compatibility is maintained on the transport layer though. The new added serialization test also uncovered a bug in the java API where the `ClusterSearchShardsRequest` could be created with no arguments, but the indices were required to be not null otherwise the request couldn't be serialized as `writeTo` would throw NPE. Fixed by setting a default value (empty array) for indices. Relates to elastic#21688
Member
Author
|
retest this please |
javanna
added a commit
that referenced
this pull request
Nov 22, 2016
The `type` parameter has always been accepted by the search_shards api, probably to make the api and its urls the same as search. Truth is that the type never had any effect, it's been ignored from day one while accepting it may make users think that we actually do something with it. This commit deprecate support for the type parameter from the REST layer and removes it from the Java API. Backwards compatibility is maintained on the transport layer though. The new added serialization test also uncovered a bug in the java API where the `ClusterSearchShardsRequest` could be created with no arguments, but the indices were required to be not null otherwise the request couldn't be serialized as `writeTo` would throw NPE. Fixed by setting a default value (empty array) for indices. Relates to #21688
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
typeparameter has always been accepted by the search_shards api, probably to make the api and its urls the same as search. Truth is that the type never had any effect, it's been ignored from day one while accepting it may make users think that we actually do something with it.This commit removes support for the type parameter from the REST layer and the Java API. Backwards compatibility is maintained on the transport layer though.
The new added serialization test also uncovered a bug in the java API where the
ClusterSearchShardsRequestcould be created with no arguments, but the indices were required to be not null otherwise the request couldn't be serialized aswriteTowould throw NPE. Fixed by setting a default value (empty array) for indices.Note that we could backport this to 5.x and make it non breaking on the REST layer, by maintaining the endpoint that accepts the type but log a deprecation warning for it. Then the version checks on the transport layer would need to be updated in this PR too.