diff --git a/docs/reference/release-highlights.md b/docs/reference/release-highlights.md index 7e66d07ef..1db1cb9a1 100644 --- a/docs/reference/release-highlights.md +++ b/docs/reference/release-highlights.md @@ -7,7 +7,11 @@ mapped_pages: These are the important new features and changes in minor releases. Every release also updates the Java API Client to the latest [API specification](https://github.com/elastic/elasticsearch-specification). This includes new APIs, as well as bug fixes in the specification of existing APIs. -For a list of detailed changes, including bug fixes, see the [GitHub project release notes](https://github.com/elastic/elasticsearch-java/releases). +For a list of detailed changes, including bug fixes, refer to the [GitHub project release notes](https://github.com/elastic/elasticsearch-java/releases). + +## 9.4.0 [release-highlights-940] + +[Release notes](/release-notes/9-4-0.md) ## 9.3.0 [release-highlights-930] diff --git a/docs/release-notes/9-4-0.md b/docs/release-notes/9-4-0.md new file mode 100644 index 000000000..8455e5a86 --- /dev/null +++ b/docs/release-notes/9-4-0.md @@ -0,0 +1,120 @@ +--- +navigation_title: "9.4.0" +--- +# Elasticsearch Java Client 9.4.0 [elasticsearch-java-client-940] + +Discover what changed in the 9.4.0 version of the Java client. + +## Breaking changes [elasticsearch-java-client-940-breaking-changes] + +This version presents many updates to existing fields that were wrongly mapped, or incomplete. Here is the complete list of changes: + +::::{dropdown} From generic json to specific type + +- elasticsearch.inference.CustomResponseParams + - `jsonParser`: modified from `json.JsonData` to `Map` + +- elasticsearch.inference.CustomServiceSettings + - `headers`: modified from `json.JsonData` to `Map`, now required + - `inputType`: modified from `json.JsonData` to `Map`, now required + - `queryParameters`: modified from `json.JsonData` to `List`, now required + - `secretParameters`: modified from `json.JsonData` to `Map` + +- elasticsearch.inference.CustomTaskSettings + - `parameters`: modified from `json.JsonData` to `Map`, now required + +- elasticsearch.inference.OpenAITaskSettings + - `headers`: modified from `json.JsonData` to `Map`, now required +:::: + +::::{dropdown} From String to Enum + +- elasticsearch.inference.ContentObject + - `type`: modified from `String` to `elasticsearch.inference.ContentType` + +- elasticsearch.searchable_snapshots.MountRequest + - `storage`: modified from `String` to `elasticsearch.searchable_snapshots.mount.StorageOption` +:::: + +::::{dropdown} Serialization changes + +From this version of the client, CSV type URL parameters with value `null` will no longer be serialized as `null`, and will be instead filtered out. +More information in the relevant PR [#1222](https://github.com/elastic/elasticsearch-java/pull/1222). +:::: + +::::{dropdown} Type removals + +- elasticsearch.indices.get_all_sample_configuration.IndexSamplingConfiguration: **removed** + +- elasticsearch.indices.DeleteSampleConfigurationRequest: **removed** + +- elasticsearch.indices.DeleteSampleConfigurationResponse: **removed** + +- elasticsearch.indices.get_sample.RawDocument: **removed** + +- elasticsearch.indices.GetAllSampleConfigurationRequest: **removed** + +- elasticsearch.indices.GetAllSampleConfigurationResponse: **removed** + +- elasticsearch.indices.GetSampleConfigurationRequest: **removed** + +- elasticsearch.indices.GetSampleConfigurationResponse: **removed** + +- elasticsearch.indices.GetSampleRequest: **removed** + +- elasticsearch.indices.GetSampleResponse: **removed** + +- elasticsearch.indices.GetSampleStatsRequest: **removed** + +- elasticsearch.indices.GetSampleStatsResponse: **removed** + +- elasticsearch.indices.PutSampleConfigurationRequest: **removed** + +- elasticsearch.indices.PutSampleConfigurationResponse: **removed** + +- elasticsearch.indices.SamplingConfiguration: **removed** + +- elasticsearch.inference.TextEmbeddingByteResult: **removed** + +- elasticsearch.inference.TextEmbeddingResult: **removed** + +- elasticsearch.security.ApiKeyManagedBy: **removed** + +- elasticsearch.streams.status.LogsStatus: **removed** +:::: + +::::{dropdown} Other changes + +- elasticsearch._types.aggregations.FieldDateMath + - `value`: modified from `Double` to `Long` + +- elasticsearch.cluster.ComponentTemplate + - `componentTemplate`: modified from `elasticsearch.cluster.ComponentTemplateNode` to `elasticsearch.cluster.ComponentTemplateNodeWithRollover` + +- elasticsearch.cluster.ComponentTemplateSummary + - `lifecycle`: modified from `elasticsearch.indices.DataStreamLifecycleWithRollover` to `elasticsearch.indices.DataStreamLifecycle` + +- elasticsearch.indices.get_index_template.IndexTemplateItem + - `indexTemplate`: modified from `elasticsearch.indices.IndexTemplate` to `elasticsearch.indices.IndexTemplateWithRollover` + +- elasticsearch.indices.IndexTemplateSummary + - `lifecycle`: modified from `elasticsearch.indices.DataStreamLifecycleWithRollover` to `elasticsearch.indices.DataStreamLifecycle` + +- elasticsearch.security.authenticate.AuthenticateApiKey + - `managedBy`: modified from `elasticsearch.security.ApiKeyManagedBy` to `elasticsearch.security.CredentialManagedBy` + +- elasticsearch.streams.StreamsStatusResponse + - `logs`: modified from `elasticsearch.streams.status.LogsStatus` to `elasticsearch.streams.status.StreamStatus` +:::: + +## Features and enhancements [elasticsearch-java-client-940-features-enhancements] + +::::{dropdown} Less generic exception messages + +Introduced with [#1213](https://github.com/elastic/elasticsearch-java/pull/1213), adding more information taken from `ElasticsearchException`'s fields to the main error message. +For example, instead of `all shards failed` the error message will be `all shards failed - Failed to parse query ["test"]`. +:::: + +## Deprecations [elasticsearch-java-client-940-deprecations] + +Nothing was deprecated in this version of the client. diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 6013fa498..135100deb 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -12,6 +12,9 @@ To check for security updates, refer to [Security announcements for the Elastic To check for issues, refer to [Known issues](../release-notes/known-issues.md). +## 9.4.0 +[Release notes](../release-notes/9-4-0.md) + ## 9.3.0 [Release notes](../release-notes/9-3-0.md) diff --git a/docs/release-notes/toc.yml b/docs/release-notes/toc.yml index 5a71931b5..b2adbf127 100644 --- a/docs/release-notes/toc.yml +++ b/docs/release-notes/toc.yml @@ -1,6 +1,7 @@ toc: - file: index.md - file: known-issues.md + - file: 9-4-0.md - file: 9-3-0.md - file: 9-2-0.md - file: 9-1-0.md