Skip to content

Commit 75f94e6

Browse files
committed
bump to version 2.5.8
1 parent e500e98 commit 75f94e6

22 files changed

+12
-84
lines changed

docs/aggregations/writing-aggregations.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,6 @@ return s => s
172172
);
173173
----
174174
<1> a list of aggregation functions to apply
175-
176175
<2> Using LINQ's `Aggregate()` function to accumulate/apply all of the aggregation functions
177176

178177
Combining multiple `AggregationDescriptor` is also possible using the bitwise `&&` operator
@@ -238,6 +237,5 @@ var maxPerChild = childAggregation.Max("max_per_child");
238237
maxPerChild.Should().NotBeNull(); <2>
239238
----
240239
<1> Do something with the average per child. Here we just assert it's not null
241-
242240
<2> Do something with the max per child. Here we just assert it's not null
243241

docs/client-concepts/certificates/working-with-certificates.asciidoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,8 @@ public class PkiCluster : CertgenCaCluster
147147
}
148148
----
149149
<1> Set the client certificate on `ConnectionSettings`
150-
151150
<2> The path to the `.cer` file
152-
153151
<3> The path to the `.key` file
154-
155152
<4> The password for the private key
156153

157154
Or per request on `RequestConfiguration` which will take precedence over the ones defined on `ConnectionConfiguration`

docs/client-concepts/connection-pooling/exceptions/unexpected-exceptions.asciidoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,8 @@ audit = await audit.TraceUnexpectedException(
6060
);
6161
----
6262
<1> set up a cluster with 10 nodes
63-
6463
<2> where node 2 on port 9201 always throws an exception
65-
6664
<3> The first call to 9200 returns a healthy response
67-
6865
<4> ...but the second call, to 9201, returns a bad response
6966

7067
Sometimes, an unexpected exception happens further down in the pipeline. In this scenario, we
@@ -103,9 +100,7 @@ audit = await audit.TraceUnexpectedException(
103100
);
104101
----
105102
<1> calls on 9200 set up to throw a `WebException`
106-
107103
<2> calls on 9201 set up to throw an `Exception`
108-
109104
<3> Assert that the audit trail for the client call includes the bad response from 9200 and 9201
110105

111106
An unexpected hard exception on ping and sniff is something we *do* try to recover from and failover to retrying on the next node.
@@ -150,8 +145,6 @@ audit = await audit.TraceUnexpectedException(
150145
);
151146
----
152147
<1> `InnerException` is the exception that brought the request down
153-
154148
<2> The hard exception that happened on ping is still available though
155-
156149
<3> An exception can be hard to relate back to a point in time, so the exception is also available on the audit trail
157150

docs/client-concepts/connection-pooling/exceptions/unrecoverable-exceptions.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ var audit = new Auditor(() => Framework.Cluster
6868
);
6969
----
7070
<1> Always succeed on ping
71-
7271
<2> ...but always fail on calls with a 401 Bad Authentication response
7372

7473
Now, let's make a client call. We'll see that the first audit event is a successful ping
@@ -89,9 +88,7 @@ audit = await audit.TraceElasticsearchException(
8988
);
9089
----
9190
<1> First call results in a successful ping
92-
9391
<2> Second call results in a bad response
94-
9592
<3> The reason for the bad response is Bad Authentication
9693

9794
When a bad authentication response occurs, the client does not attempt to deserialize the response body returned;
@@ -125,7 +122,6 @@ audit = await audit.TraceElasticsearchException(
125122
);
126123
----
127124
<1> Always return a 401 bad response with a HTML response on client calls
128-
129125
<2> Assert that the response body bytes are null
130126

131127
Now in this example, by turning on `DisableDirectStreaming()` on `ConnectionSettings`, we see the same behaviour exhibited
@@ -158,6 +154,5 @@ audit = await audit.TraceElasticsearchException(
158154
);
159155
----
160156
<1> Response bytes are set on the response
161-
162157
<2> Assert that the response contains `"nginx/"`
163158

docs/client-concepts/connection-pooling/request-overrides/disable-sniff-ping-per-request.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,8 @@ audit = await audit.TraceCalls(
6767
);
6868
----
6969
<1> disable sniffing
70-
7170
<2> first call is a successful ping
72-
7371
<3> sniff on startup call happens here, on the second call
74-
7572
<4> No sniff on startup again
7673

7774
Now, let's disable pinging on the request
@@ -95,7 +92,6 @@ audit = await audit.TraceCall(
9592
);
9693
----
9794
<1> disable ping
98-
9995
<2> No ping after sniffing
10096

10197
Finally, let's demonstrate disabling both sniff and ping on the request
@@ -117,6 +113,5 @@ audit = await audit.TraceCall(
117113
);
118114
----
119115
<1> diable ping and sniff
120-
121116
<2> no ping or sniff before the call
122117

docs/client-concepts/connection-pooling/round-robin/skip-dead-nodes.asciidoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,7 @@ await audit.TraceCalls(
142142
);
143143
----
144144
<1> The first call goes to 9200 which succeeds
145-
146145
<2> The 2nd call does a ping on 9201 because its used for the first time. It fails so we wrap over to node 9202
147-
148146
<3> The next call goes to 9203 which fails so we should wrap over
149147

150148
A cluster with 2 nodes where the second node fails on ping
@@ -194,6 +192,5 @@ await audit.TraceCalls(
194192
);
195193
----
196194
<1> All the calls fail
197-
198195
<2> After all our registered nodes are marked dead we want to sample a single dead node each time to quickly see if the cluster is back up. We do not want to retry all 4 nodes
199196

docs/client-concepts/high-level/analysis/writing-analyzers.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ var createIndexResponse = client.CreateIndex("my-index", c => c
103103
);
104104
----
105105
<1> Pre-defined list of English stopwords within Elasticsearch
106-
107106
<2> Use the `standard_english` analyzer configured
108107

109108
[source,javascript]
@@ -271,7 +270,6 @@ var createIndexResponse = client.CreateIndex("questions", c => c
271270
);
272271
----
273272
<1> Use an analyzer at index time that strips HTML tags
274-
275273
<2> Use an analyzer at search time that does not strip HTML tags
276274

277275
With this in place, the text of a question body will be analyzed with the `index_question` analyzer

docs/client-concepts/high-level/getting-started.asciidoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ var indexResponse = client.Index(person); <1>
109109
var asyncIndexResponse = await client.IndexAsync(person); <2>
110110
----
111111
<1> synchronous method that returns an `IIndexResponse`
112-
113112
<2> asynchronous method that returns a `Task<IIndexResponse>` that can be awaited
114113

115114
NOTE: All methods available within NEST are exposed as both synchronous and asynchronous versions,

docs/client-concepts/high-level/inference/field-inference.asciidoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -474,13 +474,9 @@ class Precedence
474474
}
475475
----
476476
<1> Even though this property has a NEST property mapping _and_ a `JsonProperty` attribute, We are going to provide a hard rename for it on ConnectionSettings later that should win.
477-
478477
<2> This property has both a NEST attribute and a `JsonProperty`, NEST should win.
479-
480478
<3> We should take the json property into account by itself
481-
482479
<4> This property we are going to special case in our custom serializer to resolve to ask
483-
484480
<5> We are going to register a DefaultFieldNameInferrer on ConnectionSettings that will uppercase all properties.
485481

486482
Here we create a custom serializer that renames any property named `AskSerializer` to `ask`

docs/client-concepts/high-level/inference/indices-paths.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ singleIndexFromIndexName.Match(
9090
);
9191
----
9292
<1> `_all` will override any specific index names here
93-
9493
<2> The `Project` type has been mapped to a specific index name using <<index-name-type-mapping,`.InferMappingFor<Project>`>>
9594

9695
[[nest-indices]]
@@ -121,9 +120,7 @@ ISearchRequest singleTypedRequest = new SearchDescriptor<Project>().Index(single
121120
var invalidSingleString = Nest.Indices.Index("name1, name2"); <3>
122121
----
123122
<1> specifying a single index using a string
124-
125123
<2> specifying a single index using a type
126-
127124
<3> an **invalid** single index name
128125

129126
===== Multiple indices
@@ -148,9 +145,7 @@ manyStringRequest = new SearchDescriptor<Project>().Type(new[] { "name1", "name2
148145
((IUrlParameter)manyStringRequest.Type).GetString(client.ConnectionSettings).Should().Be("name1,name2");
149146
----
150147
<1> specifying multiple indices using strings
151-
152148
<2> specifying multiple indices using types
153-
154149
<3> The index names here come from the Connection Settings passed to `TestClient`. See the documentation on <<index-name-inference, Index Name Inference>> for more details.
155150

156151
===== All Indices

0 commit comments

Comments
 (0)