Skip to content

fix doc build #8492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 11, 2025
Merged

fix doc build #8492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a3bbe0
fix doc build
bmorelli25 Apr 11, 2025
8c38f39
fix more links
bmorelli25 Apr 11, 2025
c4c5478
oops
bmorelli25 Apr 11, 2025
786ae07
fix for the fix
bmorelli25 Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/release-notes/breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ Breaking changes can impact your Elastic applications, potentially disrupting no
- [1. Container types](#1-container-types)
- [2. Removal of certain generic request descriptors](#2-removal-of-certain-generic-request-descriptors)
- [3. Removal of certain descriptor constructors and related request APIs](#3-removal-of-certain-descriptor-constructors-and-related-request-apis)
- [4. Date / Time / Duration values](#4-date--time--duration-values)
- [4. Date / Time / Duration values](#4-date-time-duration-values)
- [5. `ExtendedBounds`](#5-extendedbounds)
- [6. `Field.Format`](#6-fieldformat)
- [7. `Field`/`Fields` semantics](#7-fieldfields-semantics)
- [8. `FieldValue`](#8-fieldvalue)
- [9. `FieldSort`](#9-fieldsort)
- [10. Descriptor types `class` -\> `struct`](#10-descriptor-types-class---struct)
- [10. Descriptor types `class` -\> `struct`](#10-descriptor-types-class-struct)

### Breaking changes

#### 1. Container types
#### 1. Container types [1-container-types]

**Impact**: High.

Expand Down Expand Up @@ -67,7 +67,7 @@ new SearchRequest
};
```

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

**Impact**: High.

Expand Down Expand Up @@ -126,7 +126,7 @@ List of affected descriptors:
- `TokenizationConfigDescriptor<TDocument>`
- `UpdateDataFrameAnalyticsRequestDescriptor<TDocument>`

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

**Impact**: High.

Expand Down Expand Up @@ -159,53 +159,53 @@ new IndexRequestDescriptor(document, "my_index", Id.From(document));
await client.IndexAsync(document, "my_index", Id.From(document), ...);
```

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

**Impact**: High.

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

#### 5. `ExtendedBounds`
#### 5. `ExtendedBounds` [5-extendedbounds]

**Impact**: High.

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

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

#### 6. `Field.Format`
#### 6. `Field.Format` [6-fieldformat]

**Impact**: Low.

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

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

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

**Impact**: Low.

`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`.

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

#### 8. `FieldValue`
#### 8. `FieldValue` [8-fieldvalue]

**Impact**: Low.

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

These values have not been used for some time.

#### 9. `FieldSort`
#### 9. `FieldSort` [9-fieldsort]

**Impact**: Low.

Removed static `FieldSort.Empty` member.

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

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

**Impact**: Low.

Expand Down
40 changes: 20 additions & 20 deletions docs/release-notes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To check for security updates, go to [Security announcements for the Elastic sta
- [2.4. Union Types](#24-union-types)
- [3. Improved Descriptor Design](#3-improved-descriptor-design)
- [3.1. Wrap](#31-wrap)
- [3.2. Unwrap / Inspect](#32-unwrap--inspect)
- [3.2. Unwrap / Inspect](#32-unwrap-inspect)
- [3.3. Removal of Side Effects](#33-removal-of-side-effects)
- [4. Request Path Parameter Properties](#4-request-path-parameter-properties)
- [5. Field Name Inference](#5-field-name-inference)
Expand All @@ -46,13 +46,13 @@ To check for security updates, go to [Security announcements for the Elastic sta

### Features and enhancements

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

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

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

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

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

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

The regular APIs with merged type arguments are still available.

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

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

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

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

Note: This syntax already existed in 8.x.

Expand All @@ -90,7 +90,7 @@ new SearchRequestDescriptor<Person>()
);
```

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

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

Expand Down Expand Up @@ -146,7 +146,7 @@ new CompletionSuggesterDescriptor<Person>()
);
```

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

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

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

##### 2.4. Union Types
##### 2.4. Union Types [24-union-types]

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

Expand All @@ -178,13 +178,13 @@ new TermsQueryDescriptor()
1. `ICollection<FieldValue>`
2. `TermsLookup`

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

The 9.0 release features a completely overhauled descriptor design.

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

##### 3.1. Wrap
##### 3.1. Wrap [31-wrap]

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

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

:::

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

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

Expand All @@ -216,13 +216,13 @@ SearchRequest request = descriptor;

Unwrapping does not allocate or copy.

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

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.

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.

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

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.

Expand All @@ -238,7 +238,7 @@ var indices = request.Indices;
request.Indices = "my_index";
```

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

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.

Expand All @@ -252,7 +252,7 @@ Field field = "field"!;
Field field = "field";
```

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

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.

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

:::

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

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

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

:::

#### 8. Sorting
#### 8. Sorting [8-sorting]

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

Expand Down Expand Up @@ -349,7 +349,7 @@ new SearchRequestDescriptor<Person>()
);
```

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

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

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

:::

#### 10. Serialization
#### 10. Serialization [10-serialization]

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.

Expand Down
Loading