Skip to content

Commit 3a3bbe0

Browse files
committed
fix doc build
1 parent 0e1f05b commit 3a3bbe0

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Breaking changes can impact your Elastic applications, potentially disrupting no
3636

3737
### Breaking changes
3838

39-
#### 1. Container types
39+
#### 1. Container types [1-container-types]
4040

4141
**Impact**: High.
4242

@@ -67,7 +67,7 @@ new SearchRequest
6767
};
6868
```
6969

70-
#### 2. Removal of certain generic request descriptors
70+
#### 2. Removal of certain generic request descriptors [2-removal-of-certain-generic-request-descriptors]
7171

7272
**Impact**: High.
7373

@@ -126,7 +126,7 @@ List of affected descriptors:
126126
- `TokenizationConfigDescriptor<TDocument>`
127127
- `UpdateDataFrameAnalyticsRequestDescriptor<TDocument>`
128128

129-
#### 3. Removal of certain descriptor constructors and related request APIs
129+
#### 3. Removal of certain descriptor constructors and related request APIs [3-removal-of-certain-descriptor-constructors-and-related-request-apis]
130130

131131
**Impact**: High.
132132

@@ -159,53 +159,53 @@ new IndexRequestDescriptor(document, "my_index", Id.From(document));
159159
await client.IndexAsync(document, "my_index", Id.From(document), ...);
160160
```
161161

162-
#### 4. Date / Time / Duration values
162+
#### 4. Date / Time / Duration values [4-date--time--duration-values]
163163

164164
**Impact**: High.
165165

166166
In places where previously `long` or `double` was used to represent a date/time/duration value, `DateTimeOffset` or `TimeSpan` is now used instead.
167167

168-
#### 5. `ExtendedBounds`
168+
#### 5. `ExtendedBounds` [5-extendedbounds]
169169

170170
**Impact**: High.
171171

172172
Removed `ExtendedBoundsDate`/`ExtendedBoundsDateDescriptor`, `ExtendedBoundsFloat`/`ExtendedBoundsFloatDescriptor`.
173173

174174
Replaced by `ExtendedBounds<T>`, `ExtendedBoundsOfFieldDateMathDescriptor`, and `ExtendedBoundsOfDoubleDescriptor`.
175175

176-
#### 6. `Field.Format`
176+
#### 6. `Field.Format` [6-fieldformat]
177177

178178
**Impact**: Low.
179179

180180
Removed `Field.Format` property and corresponding constructor and inferrer overloads.
181181

182182
This property has not been used for some time (replaced by the `FieldAndFormat` type).
183183

184-
#### 7. `Field`/`Fields` semantics
184+
#### 7. `Field`/`Fields` semantics [7-fieldfields-semantics]
185185

186186
**Impact**: Low.
187187

188188
`Field`/`Fields` static factory methods and conversion operators no longer return nullable references but throw exceptions instead (`Field`) if the input `string`/`Expression`/`PropertyInfo` argument is `null`.
189189

190190
This makes implicit conversions to `Field` more user-friendly without requiring the null-forgiveness operator (`!`) ([read more](index.md#field-name-inference)).
191191

192-
#### 8. `FieldValue`
192+
#### 8. `FieldValue` [8-fieldvalue]
193193

194194
**Impact**: Low.
195195

196196
Removed `FieldValue.IsLazyDocument`, `FieldValue.IsComposite`, and the corresponding members in the `FieldValue.ValueKind` enum.
197197

198198
These values have not been used for some time.
199199

200-
#### 9. `FieldSort`
200+
#### 9. `FieldSort` [9-fieldsort]
201201

202202
**Impact**: Low.
203203

204204
Removed static `FieldSort.Empty` member.
205205

206206
Sorting got reworked which makes this member obsolete ([read more](index.md#sorting)).
207207

208-
#### 10. Descriptor types `class` -> `struct`
208+
#### 10. Descriptor types `class` -> `struct` [10-descriptor-types-class---struct]
209209

210210
**Impact**: Low.
211211

docs/release-notes/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ To check for security updates, go to [Security announcements for the Elastic sta
4646

4747
### Features and enhancements
4848

49-
#### 1. Request Method/API Changes
49+
#### 1. Request Method/API Changes [1-request-methodapi-changes]
5050

51-
##### 1.1. Synchronous Request APIs
51+
##### 1.1. Synchronous Request APIs [11-synchronous-request-apis]
5252

5353
Synchronous request APIs are no longer marked as `obsolete`. We received some feedback about this deprecation and decided to revert it.
5454

55-
##### 1.2. Separate Type Arguments for Request/Response
55+
##### 1.2. Separate Type Arguments for Request/Response [12-separate-type-arguments-for-requestresponse]
5656

5757
It is now possible to specify separate type arguments for requests/responses when executing request methods:
5858

@@ -68,13 +68,13 @@ var documents = response.Documents; <1>
6868

6969
The regular APIs with merged type arguments are still available.
7070

71-
#### 2. Improved Fluent API
71+
#### 2. Improved Fluent API [2-improved-fluent-api]
7272

7373
The enhanced fluent API generation is likely the most notable change in the 9.0 client.
7474

7575
This section describes the main syntax constructs generated based on the type of the property in the corresponding object.
7676

77-
##### 2.1. `ICollection<E>`
77+
##### 2.1. `ICollection<E>` [21-icollectione]
7878

7979
Note: This syntax already existed in 8.x.
8080

@@ -90,7 +90,7 @@ new SearchRequestDescriptor<Person>()
9090
);
9191
```
9292

93-
##### 2.2. `IDictionary<K, V>`
93+
##### 2.2. `IDictionary<K, V>` [22-idictionaryk-v]
9494

9595
The 9.0 client introduces full fluent API support for dictionary types.
9696

@@ -146,7 +146,7 @@ new CompletionSuggesterDescriptor<Person>()
146146
);
147147
```
148148

149-
##### 2.3. `ICollection<KeyValuePair<K, V>>`
149+
##### 2.3. `ICollection<KeyValuePair<K, V>>` [23-icollectionkeyvaluepairk-v]
150150

151151
Elasticsearch often uses `ICollection<KeyValuePair<K, V>>` types for ordered dictionaries.
152152

@@ -163,7 +163,7 @@ new PutMappingRequestDescriptor<Person>("index")
163163
.AddDynamicTemplate("key", x => x.Runtime(x => x.Format("123"))); // Fluent: Key + Value.
164164
```
165165

166-
##### 2.4. Union Types
166+
##### 2.4. Union Types [24-union-types]
167167

168168
Fluent syntax is now as well available for all auto-generated union- and variant-types.
169169

@@ -178,13 +178,13 @@ new TermsQueryDescriptor()
178178
1. `ICollection<FieldValue>`
179179
2. `TermsLookup`
180180

181-
#### 3. Improved Descriptor Design
181+
#### 3. Improved Descriptor Design [3-improved-descriptor-design]
182182

183183
The 9.0 release features a completely overhauled descriptor design.
184184

185185
Descriptors now wrap the object representation. This brings several internal quality-of-life improvements as well as noticeable benefits to end-users.
186186

187-
##### 3.1. Wrap
187+
##### 3.1. Wrap [31-wrap]
188188

189189
Use the wrap constructor to create a new descriptor for an existing object:
190190

@@ -203,7 +203,7 @@ Descriptors are now implemented as `struct` instead of `class`, reducing allocat
203203

204204
:::
205205

206-
##### 3.2. Unwrap / Inspect
206+
##### 3.2. Unwrap / Inspect [32-unwrap--inspect]
207207

208208
Descriptor values can now be inspected by unwrapping the object using an implicit conversion operator:
209209

@@ -216,13 +216,13 @@ SearchRequest request = descriptor;
216216

217217
Unwrapping does not allocate or copy.
218218

219-
##### 3.3. Removal of Side Effects
219+
##### 3.3. Removal of Side Effects [33-removal-of-side-effects]
220220

221221
In 8.x, execution of (most but not all) lambda actions passed to descriptors was deferred until the actual request was made. It was never clear to the user when, and how often an action would be executed.
222222

223223
In 9.0, descriptor actions are always executed immediately. This ensures no unforeseen side effects occur if the user-provided lambda action mutates external state (it is still recommended to exclusively use pure/invariant actions). Consequently, the effects of all changes performed by a descriptor method are immediately applied to the wrapped object.
224224

225-
#### 4. Request Path Parameter Properties
225+
#### 4. Request Path Parameter Properties [4-request-path-parameter-properties]
226226

227227
In 8.x, request path parameters like `Index`, `Id`, etc. could only be set by calling the corresponding constructor of the request. Afterwards, there was no way to read or change the current value.
228228

@@ -238,7 +238,7 @@ var indices = request.Indices;
238238
request.Indices = "my_index";
239239
```
240240

241-
#### 5. Field Name Inference
241+
#### 5. Field Name Inference [5-field-name-inference]
242242

243243
The `Field` type and especially its implicit conversion operations allowed for `null` return values. This led to a poor developer experience, as the null-forgiveness operator (`!`) had to be used frequently without good reason.
244244

@@ -252,7 +252,7 @@ Field field = "field"!;
252252
Field field = "field";
253253
```
254254

255-
#### 6. Uniform Date/Time/Duration Types
255+
#### 6. Uniform Date/Time/Duration Types [6-uniform-datetimeduration-types]
256256

257257
The encoding of date, time and duration values in Elasticsearch often varies depending on the context. In addition to string representations in ISO 8601 and RFC 3339 format (always UTC), also Unix timestamps (in seconds, milliseconds, nanoseconds) or simply seconds, milliseconds, nanoseconds are frequently used.
258258

@@ -266,7 +266,7 @@ There are some places where the Elasticsearch custom date/time/duration types ar
266266

267267
:::
268268

269-
#### 7. Improved Container Design
269+
#### 7. Improved Container Design [7-improved-container-design]
270270

271271
In 8.x, container types like `Query` or `Aggregation` had to be initialized using static factory methods.
272272

@@ -308,7 +308,7 @@ Consecutive assignments of variant properties (e.g., first setting `Max`, then `
308308

309309
:::
310310

311-
#### 8. Sorting
311+
#### 8. Sorting [8-sorting]
312312

313313
Applying a sort order to a search request using the fluent API is now more convenient:
314314

@@ -349,7 +349,7 @@ new SearchRequestDescriptor<Person>()
349349
);
350350
```
351351

352-
#### 9. Safer Object Creation
352+
#### 9. Safer Object Creation [9-safer-object-creation]
353353

354354
In version 9.0, users are better guided to correctly initialize objects and thus prevent invalid requests.
355355

@@ -363,7 +363,7 @@ Please note that the use of descriptors still provides the chance to create inco
363363

364364
:::
365365

366-
#### 10. Serialization
366+
#### 10. Serialization [10-serialization]
367367

368368
Serialization in version 9.0 has been completely overhauled, with a primary focus on robustness and performance. Additionally, initial milestones have been set for future support of native AOT.
369369

0 commit comments

Comments
 (0)