Skip to content

Commit aa92be3

Browse files
authored
Merge pull request #1027 from szabosteve/7.x.rev.ci.eb
[DOCS] Fine-tunes experimental and beta APIs page in PHP client book
2 parents d207c43 + 4ea7fe6 commit aa92be3

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

docs/experimental-beta-apis.asciidoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
[[experimental_and_beta_apis]]
22
== Experimental and beta APIs
33

4-
The PHP client offers also `experimental` and `beta` APIs for Elasticsearch.
5-
6-
The Elasticsearch API are marked using the following convention:
7-
8-
- **Stable** APIs should be safe to use extensively in production.
9-
Any breaking changes to these APIs should only occur in major versions and
10-
will be clearly documented in the breaking changes documentation for that
11-
release.
12-
- **Beta** APIs are on track to become stable and permanent features.
13-
Caution should be exercised in their use since it is possible we’d have to make
14-
a breaking change to these APIs in a minor version, but we’ll avoid this
15-
wherever possible.
4+
The PHP client offers also `experimental` and `beta` APIs for {es}.
5+
6+
The {es} APIs are marked using the following convention:
7+
8+
- **Stable** APIs should be safe to use extensively in production. Any breaking
9+
changes to these APIs should only occur in major versions and will be
10+
documented in the breaking changes documentation for that release.
11+
- **Beta** APIs are on track to become stable and permanent features. Use them
12+
with caution because it is possible that breaking changes are made to these
13+
APIs in a minor version.
1614
- **Experimental** APIs are just that - an experiment. An experimental API might
1715
have breaking changes in any future version, or it might even be removed
1816
entirely.
1917

2018
All the `experimental` and `beta` APIs are marked with a `@note` tag in the
2119
phpdoc section of the code.
2220

21+
2322
=== Experimental
2423

25-
The experimental APIs included in the current version of `elasticsearch-php` are:
24+
The experimental APIs included in the current version of `elasticsearch-php`
25+
are:
2626

27-
- [Ranking Evaluation](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/search-rank-eval.html)
27+
- https://www.elastic.co/guide/en/elasticsearch/reference/7.4/search-rank-eval.html[Ranking Evaluation]
2828

2929
[source,php]
3030
----
@@ -35,7 +35,7 @@ $params = [
3535
$result = $client->rankEval($params);
3636
----
3737

38-
- [Painless Execute](https://www.elastic.co/guide/en/elasticsearch/painless/7.4/painless-execute-api.html)
38+
- https://www.elastic.co/guide/en/elasticsearch/painless/7.4/painless-execute-api.html[Painless Execute]
3939

4040
[source,php]
4141
----
@@ -68,6 +68,7 @@ $client = ClientBuilder::create()->build();
6868
$result = $client->getScriptLanguages();
6969
----
7070

71+
7172
=== Beta
7273

7374
There are no beta APIs in the current version of `elasticsearch-php`.

0 commit comments

Comments
 (0)