Skip to content

Commit b35538b

Browse files
committed
[DOCS] Fix elastic.co docs headers
1 parent 18da45e commit b35538b

File tree

5 files changed

+32
-32
lines changed

5 files changed

+32
-32
lines changed

docs/release_notes/70.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This version contains the following changes:
66
* Added `elastic_ruby_console` executable. It opens a console with the elasticsearch gems you have installed required.
77
* Added macro benchmarking framework, available when developing. Use `rake -T` to view all available benchmarking tasks.
88

9-
=== Client
9+
==== Client
1010

1111
* Fixed failing integration test
1212
* Updated the Manticore development dependency
@@ -44,7 +44,7 @@ This version contains the following changes:
4444
* Update handling of publish_address in _nodes/http response
4545
* Add another test for hostname/ipv6:port format
4646

47-
=== API
47+
==== API
4848

4949
* Added the `wait_for_active_shards` parameter to the "Indices Open" API
5050
* Added the "Indices Split" API
@@ -129,7 +129,7 @@ This version contains the following changes:
129129
* Ensure that the :index param is supported for cat.segments
130130
* Ensure that the :name param is passed to the templates API
131131

132-
=== DSL
132+
==== DSL
133133

134134
* Add inner_hits option support for has_parent query
135135
* Add inner_hits option support for has_child query
@@ -153,7 +153,7 @@ This version contains the following changes:
153153
* Ensure that filters are registered when called on bool queries (#609)
154154
* Don't specify a type when creating mappings in tests
155155

156-
=== XPACK
156+
==== X-Pack
157157

158158
* Embedded the source code for the `elasticsearch-xpack` Rubygem
159159
* Fixed the `setup` for YAML integration tests

docs/release_notes/75.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- Specs have been updated to address new/deprecated parameters.
77
- Ruby versions tested: 2.3.8, 2.4.9, 2.5.7, 2.6.5 and 2.7.0 (new).
88

9-
=== API
9+
==== API
1010

1111
Endpoints that changed:
1212

@@ -45,7 +45,7 @@ Endpoints that changed:
4545
- `termvectors`: `parent` parameter is gone.
4646
- `update`: `version` parameter is not supported anymore.
4747

48-
=== X-Pack
48+
==== X-Pack
4949

5050
Some urls changed internally to remove `_xpack`, but it shouldn't affect the client's API.
5151

docs/release_notes/76.asciidoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
[[release_notes_76]]
22
=== 7.6 Release notes
33

4-
=== Client
4+
==== Client
55

66
* Support for Elasticsearch version 7.6.
77
* Last release supporting Ruby 2.4. Ruby 2.4 has reached it's end of life and no more security updates will be provided, users are suggested to update to a newer version of Ruby.
88

9-
==== API Key Support
9+
===== API Key Support
1010

1111
The client now supports API Key Authentication, check "Authentication" on the https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#authentication[transport README] for information on how to use it.
1212

13-
==== X-Opaque-Id Support
13+
===== X-Opaque-Id Support
1414

1515
The client now supports identifying running tasks with X-Opaque-Id. Check https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#identifying-running-tasks-with-x-opaque-id[transport README] for information on how to use X-Opaque-Id.
1616

17-
==== Faraday migrated to 1.0
17+
===== Faraday migrated to 1.0
1818

1919
We're now using version 1.0 of Faraday:
2020

@@ -27,9 +27,9 @@ Reference: https://github.com/lostisland/faraday/blob/master/UPGRADING.md[Upgrad
2727

2828
https://github.com/elastic/elasticsearch-ruby/pull/808[Pull Request]
2929

30-
=== API
30+
==== API
3131

32-
==== API Changes:
32+
===== API Changes:
3333

3434
- `cat.indices`: argument `bytes` options were: `b,k,m,g` and are now `b,k,kb,m,mb,g,gb,t,tb,p,pb`.
3535
- `delete_by_query`: New parameter `analyzer` - The analyzer to use for the query string.
@@ -38,26 +38,26 @@ https://github.com/elastic/elasticsearch-ruby/pull/808[Pull Request]
3838
- `rank_eval`: New parameter `search_type` - Search operation type (options: `query_then_fetch,dfs_query_then_fetch`).
3939
- `search_template`: New parameter `ccs_minimize_roundtrips` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
4040

41-
==== New API endpoints:
41+
===== New API endpoints:
4242

4343
- `get_script_context`
4444
- `get_script_languages`
4545

46-
==== Warnings:
46+
===== Warnings:
4747

4848
Synced flush is deprecated and will be removed in 8.0.
4949

50-
=== X-Pack
50+
==== X-Pack
5151

52-
==== New API endpoints:
52+
===== New API endpoints:
5353

5454
- `ml/delete_trained_model`
5555
- `ml/explain_data_frame_analytics`
5656
- `ml/get_trained_models`
5757
- `ml/get_trained_models_stats`
5858
- `ml/put_trained_model`
5959

60-
==== API changes:
60+
===== API changes:
6161

6262
- `license/get`: Added parameter `accept_enterprise`.
6363
- `ml/delete_data_frame_analytics` Added parameter `force`.

docs/release_notes/77.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33

44
This version drops support for Ruby 2.4 since it's reached it's end of life.
55

6-
=== Client
6+
==== Client
77

88
- Support for Elasticsearch version `7.7`
99

10-
==== Custom Headers
10+
===== Custom Headers
1111

1212
You can set custom HTTP headers on the client's initializer or pass them as a parameter to any API endpoint. https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#custom-http-headers[More info and code examples].
1313

14-
=== API
14+
==== API
1515

16-
==== API Changes
16+
===== API Changes
1717

1818
- Clean: Removes up some deprecated endpoints: `abort_benchmark`, `benchmark`, `delete_by_rethrottle`, `nodes.shutdown`, `remote.info`.
1919
- `expand_wildcards` Whether to expand wildcard expressions to concrete indices that are open, closed or both. Options: open, closed, hidden, none, all. `hidden` option is new. It was also added to the following endpoints: `cat.aliases`, `cat.indices`.
@@ -22,7 +22,7 @@ You can set custom HTTP headers on the client's initializer or pass them as a pa
2222
- `update_by_query`: Parameter `slices` can now be set to `auto`.
2323
- `snapshot.cleanup_repository`: Parameter `body` is removed.
2424

25-
==== New API Endpoints
25+
===== New API Endpoints
2626

2727
- `cluster.delete_component_template`
2828
- `cluster.get_component_template`
@@ -31,15 +31,15 @@ You can set custom HTTP headers on the client's initializer or pass them as a pa
3131
- `indices.delete_data_stream` (experimental)
3232
- `indices.get_data_stream` (experimental)
3333

34-
=== X-Pack
34+
==== X-Pack
3535

36-
==== API Changes
36+
===== API Changes
3737

3838
- `machine_learing.get_trained_models`: New parameter `tags`
3939
- `machine_learning.put_datafeed`, `machine_learning.update_datafeed`: Added parameters `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, `expand_wildcards`
4040
- `reload_secure_settings`: New parameter `body`, an object containing the password for the keystore.
4141

42-
==== New API Endpoints
42+
===== New API Endpoints
4343

4444
- `async_search.delete`
4545
- `async_search.get`

docs/release_notes/78.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[[release_notes_78]]
22
=== 7.8 Release notes
33

4-
=== Client
4+
==== Client
55

66
- Support for Elasticsearch version `7.8`.
77
- Surface deprecation headers from Elasticsearch. When there's a `warning` response header in Elasticsearch's response, the client will emit a warning with `warn`.
88
- Typhoeus is supported again, version 1.4+ and has been added back to the docs.
99
- Adds documentation and example for integrating with Elastic APM.
1010

11-
=== API
11+
==== API
1212

13-
==== New API Endpoints
13+
===== New API Endpoints
1414

1515
- `abort_benchmark`
1616
- `benchmark`
@@ -33,7 +33,7 @@ Experimental endpoints:
3333
- `indices.put_index_template`
3434
- `indices.simulate_index_template`
3535

36-
==== API Changes
36+
===== API Changes
3737

3838
- `cat/thread_pool`: `size` is deprecated.
3939
- `indices.get_data_streams`: `name` is now a string instead of list, the name or wildcard expression of the requested data streams.
@@ -42,9 +42,9 @@ Experimental endpoints:
4242
- `snapshot.delete_repository`: New parameter `repository`, name of the snapshot repository, wildcard (`*`) patterns are now supported.
4343
- `task.cancel`: new parameter `wait_for_completion` (boolean) Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false.
4444

45-
=== X-Pack
45+
==== X-Pack
4646

47-
==== New API Endpoints
47+
===== New API Endpoints
4848

4949
New namespace: `indices`
5050

@@ -59,7 +59,7 @@ New namespace: `searchable_snapshots`
5959
- `repository_stats`
6060
- `stats`
6161

62-
==== API Changes
62+
===== API Changes
6363

6464
- `machine_learning.delete_expired_data` new param `body`: deleting expired data parameters.
6565
- `machine_learning.delete_data_frame_analytics` new param `timeout`: controls the time to wait until a job is deleted. Defaults to 1 minute.

0 commit comments

Comments
 (0)