Skip to content

Commit 3a11380

Browse files
picandocodigopicandocodigo
committed
[DOCS] Release notes 8.13
1 parent 59d7fe5 commit 3a11380

File tree

3 files changed

+147
-0
lines changed

3 files changed

+147
-0
lines changed

‎CHANGELOG.md

+69
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,73 @@
11
*To see release notes for the `7.x` branch and older releases, see [CHANGELOG on the 7.17 branch](https://github.com/elastic/elasticsearch-ruby/blob/7.17/CHANGELOG.md).*
2+
3+
## 8.13.0 Release notes
4+
5+
### Client
6+
* Tested versions of Ruby for 8.13.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
7+
8+
### Experimental ES|QL Helper
9+
10+
This version provides a new experimental Helper for the ES|QL `query` API. Please check out [the documentation](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html#esql-helper) and [open an issue](https://github.com/elastic/elasticsearch-ruby/issues/new/choose) if you encounter any problems or have any feedback.
11+
12+
### API
13+
14+
API Changes:
15+
16+
* `async_search.status` - adds Time `:keep_alive` parameter: Specify the time interval in which the results (partial or final) for this search will be available.
17+
* `bulk` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.
18+
* `connector.list` - Adds the following parameters:
19+
* `:index_name` (List): A comma-separated list of connector index names to fetch connector documents for.
20+
* `:connector_name` (List): A comma-separated list of connector names to fetch connector documents for.
21+
* `:service_type` (List): A comma-separated list of connector service types to fetch connector documents for.
22+
* `:query` (String): A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names.
23+
* `esql.query` - adds boolean `:drop_null_columns` parameter: Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
24+
* `field_caps` - Adds `:include_empty_fields` boolean parameter: Include empty fields in result.
25+
* `index` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.
26+
* `indices.rollover` - adds boolean `:lazy` parameter: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
27+
* connector_sync_job.list - adds List `:job_type` parameter: A comma-separated list of job types.
28+
* `inference.delete_model`, `inference.get_model`, `inference.inference`, `inference.put_model`: renames `:model_id` parameter to `:inference_id`.
29+
* `termvector` will show a warning since it's been deprecated. Please use the plural version, `termvectors`.
30+
31+
New APIs:
32+
33+
* `indices.resolve_cluster` - Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
34+
* `profiling.flamegraph` - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
35+
* `profiling.stacktraces` - Extracts raw stacktrace information from Universal Profiling.
36+
* `security.query_user` - Retrieves information for Users using a subset of query DSL
37+
* `text_structure.test_grok_pattern` - Tests a Grok pattern on some text.
38+
39+
APIs Migrated from experimental to stable:
40+
41+
* `synonyms.delete_synonym`
42+
* `synonyms.delete_synonym_rule`
43+
* `synonyms.get_synonym`
44+
* `synonyms.get_synonym_rule`
45+
* `synonyms.get_synonyms_sets`
46+
* `synonyms.put_synonym`
47+
* `synonyms.put_synonym_rule`
48+
49+
New Experimental APIs:
50+
51+
* `connector.update_api_key_id` - Updates the API key id and/or API key secret id fields in the connector document.
52+
* `connector.update_index_name` - Updates the index name of the connector.
53+
* `connector.update_native` - Updates the is_native flag of the connector.
54+
* `connector.update_service_type` - Updates the service type of the connector.
55+
* `connector.update_status` - Updates the status of the connector.
56+
* `esql.async_query` - Executes an ESQL request asynchronously
57+
* `esql.async_query_get` - Retrieves the results of a previously submitted async query request given its ID.
58+
59+
New Experimental namespace `connector_secret`:
60+
61+
* `connector_secret.delete` - Deletes a connector secret.
62+
* `connector_secret.get` - Retrieves a secret stored by Connectors.
63+
* `connector_secret.post` - Creates a secret for a Connector.
64+
* `connector_secret.put` - Creates or updates a secret for a Connector.
65+
66+
### Development
67+
68+
* Migrated from `byebug` to `debug`.
69+
* Added extra testing for OpenTelemetry.
70+
271
## 8.12.0 Release notes
372

473
### Client

‎docs/release_notes/813.asciidoc

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
[[release_notes_8_13]]
2+
=== 8.13 Release notes
3+
4+
[discrete]
5+
[[release_notes_8_13_0]]
6+
=== 8.13.0 Release notes
7+
8+
[discrete]
9+
==== Client
10+
* Tested versions of Ruby for 8.13.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
11+
12+
[discrete]
13+
==== Experimental ES|QL Helper
14+
15+
This version provides a new experimental Helper for the ES|QL `query` API. Please check out https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html#esql-helper[the documentation] and https://github.com/elastic/elasticsearch-ruby/issues/new/choose[open an issue] if you encounter any problems or have any feedback.
16+
17+
[discrete]
18+
==== API
19+
20+
API Changes:
21+
22+
* `async_search.status` - adds Time `:keep_alive` parameter: Specify the time interval in which the results (partial or final) for this search will be available.
23+
* `bulk` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.
24+
* `connector.list` - Adds the following parameters:
25+
* `:index_name` (List): A comma-separated list of connector index names to fetch connector documents for.
26+
* `:connector_name` (List): A comma-separated list of connector names to fetch connector documents for.
27+
* `:service_type` (List): A comma-separated list of connector service types to fetch connector documents for.
28+
* `:query` (String): A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names.
29+
* `esql.query` - adds boolean `:drop_null_columns` parameter: Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
30+
* `field_caps` - Adds `:include_empty_fields` boolean parameter: Include empty fields in result.
31+
* `index` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.
32+
* `indices.rollover` - adds boolean `:lazy` parameter: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
33+
* connector_sync_job.list - adds List `:job_type` parameter: A comma-separated list of job types.
34+
* `inference.delete_model`, `inference.get_model`, `inference.inference`, `inference.put_model`: renames `:model_id` parameter to `:inference_id`.
35+
* `termvector` will show a warning since it's been deprecated. Please use the plural version, `termvectors`.
36+
37+
New APIs:
38+
39+
* `indices.resolve_cluster` - Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
40+
* `profiling.flamegraph` - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
41+
* `profiling.stacktraces` - Extracts raw stacktrace information from Universal Profiling.
42+
* `security.query_user` - Retrieves information for Users using a subset of query DSL
43+
* `text_structure.test_grok_pattern` - Tests a Grok pattern on some text.
44+
45+
APIs Migrated from experimental to stable:
46+
47+
* `synonyms.delete_synonym`
48+
* `synonyms.delete_synonym_rule`
49+
* `synonyms.get_synonym`
50+
* `synonyms.get_synonym_rule`
51+
* `synonyms.get_synonyms_sets`
52+
* `synonyms.put_synonym`
53+
* `synonyms.put_synonym_rule`
54+
55+
New Experimental APIs
56+
57+
* `connector.update_api_key_id` - Updates the API key id and/or API key secret id fields in the connector document.
58+
* `connector.update_index_name` - Updates the index name of the connector.
59+
* `connector.update_native` - Updates the is_native flag of the connector.
60+
* `connector.update_service_type` - Updates the service type of the connector.
61+
* `connector.update_status` - Updates the status of the connector.
62+
* `esql.async_query` - Executes an ESQL request asynchronously
63+
* `esql.async_query_get` - Retrieves the results of a previously submitted async query request given its ID.
64+
65+
New Experimental namespace `connector_secret`:
66+
67+
* `connector_secret.delete` - Deletes a connector secret.
68+
* `connector_secret.get` - Retrieves a secret stored by Connectors.
69+
* `connector_secret.post` - Creates a secret for a Connector.
70+
* `connector_secret.put` - Creates or updates a secret for a Connector.
71+
72+
[discrete]
73+
==== Development
74+
75+
* Migrated from `byebug` to `debug`.
76+
* Added extra testing for OpenTelemetry.

‎docs/release_notes/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
[discrete]
55
=== 8.x
6+
* <<release_notes_8_13, 8.13 Release Notes>>
67
* <<release_notes_8_12, 8.12 Release Notes>>
78
* <<release_notes_8110, 8.11 Release Notes>>
89
* <<release_notes_8100, 8.10 Release Notes>>
@@ -34,6 +35,7 @@
3435
* <<release_notes_75, 7.5 Release Notes>>
3536
* <<release_notes_70, 7.0 Release Notes>>
3637

38+
include::813.asciidoc[]
3739
include::812.asciidoc[]
3840
include::811.asciidoc[]
3941
include::810.asciidoc[]

0 commit comments

Comments
 (0)