Feature/5x breaking changes docs #2491
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
gmarz
suggested changes
Dec 12, 2016
|
|
||
| ## Visibility changes | ||
|
|
||
| These were types/methods/properties/constructors that were public but had nbno business being so. |
|
|
||
| ## Rename of API related methods | ||
|
|
||
| Impact low, these have been renamed to match their Methid name equivalents |
|
|
||
| ## Rest spec updates | ||
|
|
||
| These are breaking changes due to the elasticsearch 5.0 rest spec changing |
There was a problem hiding this comment.
elasticsearch => Elasticsearch
|
|
||
| ## Removed in 5.x after obsolete period | ||
|
|
||
| These are types/properties/methods obsoleted in NEST 2.x that have now been removed. |
There was a problem hiding this comment.
obsoleted => marked obsolete
| # Breaking Changes | ||
|
|
||
| Oh my goodness, this looks like a lot of breaking changes! This is true but please take note that this list is very very extensive | ||
| It includes every single *binary* breaking change. In alot of cases these will not necessarily equate to compiler errors. |
| **public property Nest.IBulkUpdateOperation<TDocument, TPartialDocument>.Script** *Declaration changed (Breaking)* | ||
| **public property Nest.UpdateRequest<TDocument, TPartialDocument>.Script** *Declaration changed (Breaking)* | ||
|
|
||
| In some cases the we abused IScript to send template queries this is now fixed |
|
|
||
| The visitors should be passed interfaces not concrete types see: https://github.com/elastic/elasticsearch-net/pull/2320 | ||
|
|
||
| ## Deprecated queryies are now removed |
|
|
||
| ## Visibility changes | ||
|
|
||
| Impact low, these are types/methods/constructors that were never suppose to be public. |
|
|
||
| ## Allow source filter to send false | ||
|
|
||
| In NEST 2.x we would always send Source.Exlcude as `_source: { exclude: [""] }` in 5.x the we use a union of `bool` |
| **public method Nest.IElasticClient.GetAlias** *Declaration changed (Breaking)* | ||
| **public method Nest.IElasticClient.GetAlias** *Declaration changed (Breaking)* | ||
|
|
||
| ## Sugest is bound over T |
russcam
suggested changes
Dec 12, 2016
| # Breaking Changes | ||
|
|
||
| Oh my goodness, this looks like a lot of breaking changes! This is true but please take note that this list is very very extensive | ||
| It includes every single *binary* breaking change. In alot of cases these will not necessarily equate to compiler errors. |
|
|
||
| The visitors should be passed interfaces not concrete types see: https://github.com/elastic/elasticsearch-net/pull/2320 | ||
|
|
||
| ## Deprecated queryies are now removed |
| **public property Nest.SearchRequest<T>.Source** *Declaration changed (Breaking)* | ||
| **public property Nest.TopHitsAggregation.Source** *Declaration changed (Breaking)* | ||
|
|
||
| `Exclude` and `Include` are now plural on `ISourceFilter` |
There was a problem hiding this comment.
in line with the change in Elasticsearch 5.0
| **public method Nest.IElasticClient.GetAlias** *Declaration changed (Breaking)* | ||
| **public method Nest.IElasticClient.GetAlias** *Declaration changed (Breaking)* | ||
|
|
||
| ## Sugest is bound over T |
|
|
||
| # Read only data types on responses. | ||
|
|
||
| Responses now favor `IReadOnlyDictionary` and `IReadOnlyCollection` which are initialized as empty. |
There was a problem hiding this comment.
Use the open generic type names IReadOnlyDictionary<TKey, TValue> and IReadOnlyCollection<T>
| **public property Nest.IClusterRerouteResponse.Explanations** | ||
| **public property Nest.IGetSnapshotResponse.Snapshots** | ||
| **public property Nest.IGraphExploreResponse.Connections** | ||
| **public property Nest.IGraphExploreResponse.Failures |
There was a problem hiding this comment.
With NEST 2.x you had to pass cancellation tokens as part of the
RequestConfigurationwe now bumped these to the methods themselves
to
With NEST 2.x async methods, a cancellation tokens could be passed as part of the
RequestConfiguration. This was not very discoverable and so each async method can now accept an optional cancellation token as an argument, making the API more async idiomatic.
Mpdreamz
added a commit
that referenced
this pull request
Dec 12, 2016
* started on NEST breaking changes documentation * 2x code was rendered in place of 5x code * cancellationtoken changes does not need to show code, just where it was added * cancellationtoken changes does not need to show code, just where it was added * no need to show code for all the readonly changes * started on manually annotating the breaking changes * removed code from removal section and reordered docs * manually categorized more changes * small touchups and breaking changes preface * low level breaking changes API * add breaking changes pointer file * final small tweaks: removed todo and changed ascii section title to be unique * typos ty @gmarz @russcam
|
ported to |
awelburn
pushed a commit
to Artesian/elasticsearch-net
that referenced
this pull request
Nov 6, 2017
* started on NEST breaking changes documentation * 2x code was rendered in place of 5x code * cancellationtoken changes does not need to show code, just where it was added * cancellationtoken changes does not need to show code, just where it was added * no need to show code for all the readonly changes * started on manually annotating the breaking changes * removed code from removal section and reordered docs * manually categorized more changes * small touchups and breaking changes preface * low level breaking changes API * add breaking changes pointer file * final small tweaks: removed todo and changed ascii section title to be unique * typos ty @gmarz @russcam
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.
No description provided.