Skip to content

Commit c963518

Browse files
committed
Updated release notes in docs
1 parent 7875ed3 commit c963518

File tree

1 file changed

+153
-0
lines changed

1 file changed

+153
-0
lines changed

docs/release-notes/index.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,159 @@ To check for security updates, go to [Security announcements for the Elastic sta
2020
% ### Fixes [elasticsearch-php-client-next-fixes]
2121
% *
2222

23+
## 9.1.0 [elasticsearch-php-client-910-release-notes]
24+
25+
This release includes the following endpoint changes for [Elasticsearch 9.1.0](https://www.elastic.co/docs/release-notes/elasticsearch#elasticsearch-9.1.0-release-notes):
26+
27+
### Cluster.getComponentTemplate
28+
29+
- Added `flat_settings` parameter (bool), return settings in flat format (default: false)
30+
- Added `settings_filter` parameter (string), filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
31+
32+
### Cluster.putComponentTemplate
33+
34+
- Removed `timeout` parameter
35+
- Added `cause` parameter (string), user defined reason for create the component template
36+
37+
### Eql.search
38+
39+
- Added `ccs_minimize_roundtrips` parameter (bool), indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
40+
- Added `ignore_unavailable` parameter (bool), whether specified concrete indices should be ignored when unavailable (missing or closed)
41+
- Added `allow_no_indices` parameter (bool), whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
42+
- Added `expand_wildcards` parameter (string), whether to expand wildcard expression to concrete indices that are open, closed or both.
43+
44+
### Esql.asyncQuery
45+
46+
- Added `allow_partial_results` parameter (bool), if `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures.
47+
48+
### Esql.asyncQueryGet
49+
50+
- Added `format` parameter (string), a short version of the Accept header, e.g. json, yaml
51+
52+
### Esql.getQuery (new EXPERIMENTAL API, available on serverless)
53+
54+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-esql-get-query
55+
56+
### Esql.listQueries (new EXPERIMENTAL API, available on serverless)
57+
58+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-esql-list-queries
59+
60+
### Esql.query
61+
62+
- Added `allow_partial_results` parameter (bool), if `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures.
63+
64+
### Indices.deleteDataStreamOptions (new API)
65+
66+
- Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
67+
- API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream_options.json
68+
69+
### Indices.getDataStreamOptions (new API, available on serverless)
70+
71+
- Docuemntation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-get-data-stream-options
72+
73+
### Indices.getDataStreamSettings (new API, available on serverless)
74+
75+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-get-data-stream-settings
76+
77+
### Indices.getFieldMapping
78+
79+
- Removed the `local` parameter.
80+
81+
### Indices.putDataStreamOptions (new API, available on serverless)
82+
83+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-put-data-stream-options
84+
85+
### Indices.putDataStreamSettings (new API, available on serverless)
86+
87+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-put-data-stream-settings
88+
89+
### Indices.recovery
90+
91+
- Added `ignore_unavailable` parameter (bool), whether specified concrete indices should be ignored when unavailable (missing or closed)
92+
- Added `allow_no_indices` parameter (bool), whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
93+
- Added `expand_wildcards` parameter (string), whether to expand wildcard expression to concrete indices that are open, closed or both.
94+
95+
### Indices.removeBlock (new API, available on serverless)
96+
97+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-remove-block
98+
99+
### Inference.putAmazonsagemaker (new API, available on serverless)
100+
101+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-inference-put-amazonsagemaker
102+
103+
### Inference.putCustom (new API, available on serverless)
104+
105+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-inference-put-custom
106+
107+
### Inference.putDeepseek (new API, available on serverless)
108+
109+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-deepseek
110+
111+
### Snapshot.get
112+
113+
- Added `state` parameter (string|array<string>), filter snapshots by a comma-separated list of states. Valid state values are 'SUCCESS', 'IN_PROGRESS', 'FAILED', 'PARTIAL', or 'INCOMPATIBLE'.
114+
115+
### Snapshot.repositoryAnalyze
116+
117+
- Added `register_operation_count` parameter (int), the minimum number of linearizable register operations to perform in total. Defaults to 10.
118+
119+
### Snapshot.repositoryVerifyIntegrity (new EXPERIMENTAL API)
120+
121+
- Documentation: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository
122+
123+
### Streams.logsDisable (new API)
124+
125+
- Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html
126+
- API: https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html
127+
128+
### Streams.logsEnable (new API)
129+
130+
- Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-enable.html
131+
- API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_enable.json
132+
133+
### Streams.status (new API)
134+
135+
- Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-status.html
136+
- API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/streams.status.json
137+
138+
### Synonyms.deleteSynonymRule
139+
140+
- Added `refresh` parameter (bool), refresh search analyzers to update synonyms
141+
142+
### Synonyms.putSynonym
143+
144+
- Added `refresh` parameter (bool), refresh search analyzers to update synonyms
145+
146+
### Synonyms.putSynonymRule
147+
148+
- Added `refresh` parameter (bool), refresh search analyzers to update synonyms
149+
150+
### create
151+
152+
- Added `require_alias` parameter (bool), when true, requires destination to be an alias. Default is false
153+
- Added `require_data_stream` parameter (bool), when true, requires destination to be a data stream (existing or to be created). Default is false
154+
155+
### msearch
156+
157+
- Added `ignore_unavailable` parameter (bool), whether specified concrete indices should be ignored when unavailable (missing or closed)
158+
- Added `ignore_throttled` parameter (bool), whether specified concrete, expanded or aliased indices should be ignored when throttled
159+
- Added `allow_no_indices` parameter (bool), whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
160+
- Added `expand_wildcards` parameter (string), whether to expand wildcard expression to concrete indices that are open, closed or both.
161+
- Added `routing` parameter (string|array<string>), a comma-separated list of specific routing values
162+
- Added `include_named_queries_score` parameter (bool), indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)
163+
164+
### openPointInTime
165+
166+
- Added `max_concurrent_shard_requests` parameter (int), the number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster
167+
168+
### reindex
169+
170+
- Added `require_alias` parameter (bool), when true, requires destination to be an alias.
171+
172+
### searchMvt
173+
174+
- Added `grid_agg` parameter (string), aggregation used to create a grid for `field`.
175+
23176
## 9.0.0 [elasticsearch-php-client-900-release-notes]
24177

25178
### Features and enhancements [elasticsearch-php-client-900-features-enhancements]

0 commit comments

Comments
 (0)