Skip to content

Commit c26273e

Browse files
authored
Added 9.4 docs (#1224)
* added 9.4 docs * fix nav title * addressing lint comments
1 parent c38308d commit c26273e

4 files changed

Lines changed: 129 additions & 1 deletion

File tree

docs/reference/release-highlights.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ mapped_pages:
77

88
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.
99

10-
For a list of detailed changes, including bug fixes, see the [GitHub project release notes](https://github.com/elastic/elasticsearch-java/releases).
10+
For a list of detailed changes, including bug fixes, refer to the [GitHub project release notes](https://github.com/elastic/elasticsearch-java/releases).
11+
12+
## 9.4.0 [release-highlights-940]
13+
14+
[Release notes](/release-notes/9-4-0.md)
1115

1216
## 9.3.0 [release-highlights-930]
1317

docs/release-notes/9-4-0.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
navigation_title: "9.4.0"
3+
---
4+
# Elasticsearch Java Client 9.4.0 [elasticsearch-java-client-940]
5+
6+
Discover what changed in the 9.4.0 version of the Java client.
7+
8+
## Breaking changes [elasticsearch-java-client-940-breaking-changes]
9+
10+
This version presents many updates to existing fields that were wrongly mapped, or incomplete. Here is the complete list of changes:
11+
12+
::::{dropdown} From generic json to specific type
13+
14+
- elasticsearch.inference.CustomResponseParams
15+
- `jsonParser`: modified from `json.JsonData` to `Map`
16+
17+
- elasticsearch.inference.CustomServiceSettings
18+
- `headers`: modified from `json.JsonData` to `Map`, now required
19+
- `inputType`: modified from `json.JsonData` to `Map`, now required
20+
- `queryParameters`: modified from `json.JsonData` to `List`, now required
21+
- `secretParameters`: modified from `json.JsonData` to `Map`
22+
23+
- elasticsearch.inference.CustomTaskSettings
24+
- `parameters`: modified from `json.JsonData` to `Map`, now required
25+
26+
- elasticsearch.inference.OpenAITaskSettings
27+
- `headers`: modified from `json.JsonData` to `Map`, now required
28+
::::
29+
30+
::::{dropdown} From String to Enum
31+
32+
- elasticsearch.inference.ContentObject
33+
- `type`: modified from `String` to `elasticsearch.inference.ContentType`
34+
35+
- elasticsearch.searchable_snapshots.MountRequest
36+
- `storage`: modified from `String` to `elasticsearch.searchable_snapshots.mount.StorageOption`
37+
::::
38+
39+
::::{dropdown} Serialization changes
40+
41+
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.
42+
More information in the relevant PR [#1222](https://github.com/elastic/elasticsearch-java/pull/1222).
43+
::::
44+
45+
::::{dropdown} Type removals
46+
47+
- elasticsearch.indices.get_all_sample_configuration.IndexSamplingConfiguration: **removed**
48+
49+
- elasticsearch.indices.DeleteSampleConfigurationRequest: **removed**
50+
51+
- elasticsearch.indices.DeleteSampleConfigurationResponse: **removed**
52+
53+
- elasticsearch.indices.get_sample.RawDocument: **removed**
54+
55+
- elasticsearch.indices.GetAllSampleConfigurationRequest: **removed**
56+
57+
- elasticsearch.indices.GetAllSampleConfigurationResponse: **removed**
58+
59+
- elasticsearch.indices.GetSampleConfigurationRequest: **removed**
60+
61+
- elasticsearch.indices.GetSampleConfigurationResponse: **removed**
62+
63+
- elasticsearch.indices.GetSampleRequest: **removed**
64+
65+
- elasticsearch.indices.GetSampleResponse: **removed**
66+
67+
- elasticsearch.indices.GetSampleStatsRequest: **removed**
68+
69+
- elasticsearch.indices.GetSampleStatsResponse: **removed**
70+
71+
- elasticsearch.indices.PutSampleConfigurationRequest: **removed**
72+
73+
- elasticsearch.indices.PutSampleConfigurationResponse: **removed**
74+
75+
- elasticsearch.indices.SamplingConfiguration: **removed**
76+
77+
- elasticsearch.inference.TextEmbeddingByteResult: **removed**
78+
79+
- elasticsearch.inference.TextEmbeddingResult: **removed**
80+
81+
- elasticsearch.security.ApiKeyManagedBy: **removed**
82+
83+
- elasticsearch.streams.status.LogsStatus: **removed**
84+
::::
85+
86+
::::{dropdown} Other changes
87+
88+
- elasticsearch._types.aggregations.FieldDateMath
89+
- `value`: modified from `Double` to `Long`
90+
91+
- elasticsearch.cluster.ComponentTemplate
92+
- `componentTemplate`: modified from `elasticsearch.cluster.ComponentTemplateNode` to `elasticsearch.cluster.ComponentTemplateNodeWithRollover`
93+
94+
- elasticsearch.cluster.ComponentTemplateSummary
95+
- `lifecycle`: modified from `elasticsearch.indices.DataStreamLifecycleWithRollover` to `elasticsearch.indices.DataStreamLifecycle`
96+
97+
- elasticsearch.indices.get_index_template.IndexTemplateItem
98+
- `indexTemplate`: modified from `elasticsearch.indices.IndexTemplate` to `elasticsearch.indices.IndexTemplateWithRollover`
99+
100+
- elasticsearch.indices.IndexTemplateSummary
101+
- `lifecycle`: modified from `elasticsearch.indices.DataStreamLifecycleWithRollover` to `elasticsearch.indices.DataStreamLifecycle`
102+
103+
- elasticsearch.security.authenticate.AuthenticateApiKey
104+
- `managedBy`: modified from `elasticsearch.security.ApiKeyManagedBy` to `elasticsearch.security.CredentialManagedBy`
105+
106+
- elasticsearch.streams.StreamsStatusResponse
107+
- `logs`: modified from `elasticsearch.streams.status.LogsStatus` to `elasticsearch.streams.status.StreamStatus`
108+
::::
109+
110+
## Features and enhancements [elasticsearch-java-client-940-features-enhancements]
111+
112+
::::{dropdown} Less generic exception messages
113+
114+
Introduced with [#1213](https://github.com/elastic/elasticsearch-java/pull/1213), adding more information taken from `ElasticsearchException`'s fields to the main error message.
115+
For example, instead of `all shards failed` the error message will be `all shards failed - Failed to parse query ["test"]`.
116+
::::
117+
118+
## Deprecations [elasticsearch-java-client-940-deprecations]
119+
120+
Nothing was deprecated in this version of the client.

docs/release-notes/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ To check for security updates, refer to [Security announcements for the Elastic
1212

1313
To check for issues, refer to [Known issues](../release-notes/known-issues.md).
1414

15+
## 9.4.0
16+
[Release notes](../release-notes/9-4-0.md)
17+
1518
## 9.3.0
1619
[Release notes](../release-notes/9-3-0.md)
1720

docs/release-notes/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
toc:
22
- file: index.md
33
- file: known-issues.md
4+
- file: 9-4-0.md
45
- file: 9-3-0.md
56
- file: 9-2-0.md
67
- file: 9-1-0.md

0 commit comments

Comments
 (0)