Skip to content

Commit 83c009c

Browse files
committed
Indicate which commits breaking changes have been calculated from
Fix small code formatting
1 parent b8cdbc0 commit 83c009c

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

docs/6.0-breaking-changes/elasticsearch-net-breaking-changes.asciidoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
[[elasticsearch-net-breaking-changes]]
22
== Elasticsearch.Net Breaking Changes
33

4-
This lists *all* the binary breaking changes in Elasticsearch.Net from 5.x to 6.x. The intention in providing such a list
5-
is to allow one to quickly search
4+
This lists *all* the binary breaking changes in Elasticsearch.Net from 5.x ({github}/tree/e8013698ab5e4fec1b310ecd724f66f472746fed[last commit in 5.x at time of 6.0.0 GA release]) to 6.x ({github}/tree/6.0.0[6.0.0 GA release]). The intention in providing such a large list
5+
is to allow you to quickly and easily search the changes between the two major versions, to understand what has been removed and
6+
equally importantly, what has been added.
67

78
[float]
89
=== Requests
@@ -137,15 +138,15 @@ Since 1.x, request parameters were fluent e.g.
137138

138139
[source,csharp]
139140
----
140-
client.Search<dynamic>(r=>r.Parameter())`
141+
client.Search<dynamic>(r => r.Parameter())`
141142
----
142143

143144
This was done back in the day to facilitate the high-level client but was never truly needed.
144145
Now, the low-level client is using
145146

146147
[source,csharp]
147148
----
148-
client.Search&lt;DynamicResponse&gt;(new SearchRequestParameters { Parameter = .. })`.
149+
client.Search<DynamicResponse>(new SearchRequestParameters { Parameter = .. })`.
149150
----
150151

151152
This change affects the following:
@@ -2700,13 +2701,13 @@ Dictionary<String, Object>
27002701
[float]
27012702
=== Responses
27022703

2703-
In previous version any `client.Operation&lt;T&gt;(..)` accepted `string` `byte[]`, `dynamic`, `Stream`, `VoidResponse`, or any object to
2704-
deserialize the response into as `T` and returned an `ElasticsearchResponse&lt;T&gt;`.
2704+
In previous version any `client.Operation<T>(..)` accepted `string` `byte[]`, `dynamic`, `Stream`, `VoidResponse`, or any object to
2705+
deserialize the response into as `T` and returned an `ElasticsearchResponse<T>`.
27052706

27062707
We are now stricter and constrained `T` to `IElasticsearchResponse` and always return T directly.
27072708

27082709
To help ease the common use cases we ship with an `BytesResponse`, `StringResponse`, `DynamicResponse`,
2709-
`VoidResponse` and `ElasticsearchResponse&lt;T&gt;` where `T` can again be any object to deserialize the response into.
2710+
`VoidResponse` and `ElasticsearchResponse<T>` where `T` can again be any object to deserialize the response into.
27102711

27112712
In previous versions the low level client was in charge of reading deserialized exceptions from Elasticsearch
27122713
and short circuited if a bad HTTP status code was returned to do so. Omitting the deserializer all together.

docs/6.0-breaking-changes/nest-breaking-changes.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[[nest-breaking-changes]]
22
== NEST Breaking Changes
33

4-
This lists *all* the binary breaking changes in NEST from 5.x to 6.x.
4+
This lists *all* the binary breaking changes in NEST from 5.x ({github}/tree/e8013698ab5e4fec1b310ecd724f66f472746fed[last commit in 5.x at time of 6.0.0 GA release]) to 6.x ({github}/tree/6.0.0[6.0.0 GA release]). The intention in providing such a large list
5+
is to allow you to quickly and easily search the changes between the two major versions, to understand what has been removed and
6+
equally importantly, what has been added.
57

68
Oh my goodness, this looks like a lot of breaking changes! In a lot of cases however,
79
changes will not necessarily equate to compiler errors and therefore no action would be required on upgrade.

0 commit comments

Comments
 (0)