Skip to content

Commit bf113bc

Browse files
committed
[DOCS] Adds 8.2 Release Notes
1 parent c857dfa commit bf113bc

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
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).*
22

3+
## 8.2.0
4+
5+
- Tested versions of Ruby for 8.2.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
6+
7+
### API
8+
9+
Updated for compatibility with Elasticsearch 8.2's API.
10+
11+
#### New parameters:
12+
13+
* `field_caps`
14+
- `filters` An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent
15+
- `types` Only return results for fields that have one of the types in the list
16+
17+
#### New APIs:
18+
19+
- `cat.component_templates` - Returns information about existing component_templates templates.
20+
- `ml.get_memory_stats` - Returns information on how ML is using memory.
21+
22+
#### New Experimental APIs:
23+
24+
- `security.activate_user_profile` - Creates or updates the user profile on behalf of another user.
25+
- `security.disable_user_profile` - Disables a user profile so it's not visible in user profile searches.
26+
- `security.enable_user_profile` - Enables a user profile so it's visible in user profile searches.
27+
- `security.get_user_profile` - Retrieves a user profile for the given unique ID.
28+
- `security.suggest_user_profiles` - Get suggestions for user profiles that match specified search criteria.
29+
- `security.update_user_profile_data` - Update application specific data for the user profile of the given unique ID.
330

431
## 8.1.2, 8.0.1
532

docs/release_notes/82.asciidoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[[release_notes_82]]
2+
=== 8.2 Release notes
3+
4+
- Tested versions of Ruby for 8.2.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
5+
6+
[discrete]
7+
==== API
8+
9+
Updated for compatibility with Elasticsearch 8.2's API.
10+
11+
[discrete]
12+
===== New parameters:
13+
14+
* `field_caps`
15+
** `filters` An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent
16+
** `types` Only return results for fields that have one of the types in the list
17+
18+
[discrete]
19+
===== New APIs
20+
21+
- `cat.component_templates` - Returns information about existing component_templates templates.
22+
- `ml.get_memory_stats` - Returns information on how ML is using memory.
23+
24+
[discrete]
25+
===== New Experimental APIs
26+
- `security.activate_user_profile` - Creates or updates the user profile on behalf of another user.
27+
- `security.disable_user_profile` - Disables a user profile so it's not visible in user profile searches.
28+
- `security.enable_user_profile` - Enables a user profile so it's visible in user profile searches.
29+
- `security.get_user_profile` - Retrieves a user profile for the given unique ID.
30+
- `security.suggest_user_profiles` - Get suggestions for user profiles that match specified search criteria.
31+
- `security.update_user_profile_data` - Update application specific data for the user profile of the given unique ID.

docs/release_notes/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
[discrete]
55
=== 8.x
6+
* <<release_notes_82, 8.2 Release Notes>>
67
* <<release_notes_81, 8.1 Release Notes>>
78
* <<release_notes_80, 8.0 Release Notes>>
89

@@ -23,6 +24,7 @@
2324
* <<release_notes_75, 7.5 Release Notes>>
2425
* <<release_notes_70, 7.0 Release Notes>>
2526

27+
include::82.asciidoc[]
2628
include::81.asciidoc[]
2729
include::80.asciidoc[]
2830
include::717.asciidoc[]

0 commit comments

Comments
 (0)