1
1
[[experimental_and_beta_apis]]
2
2
== Experimental and beta APIs
3
3
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.
16
14
- **Experimental** APIs are just that - an experiment. An experimental API might
17
15
have breaking changes in any future version, or it might even be removed
18
16
entirely.
19
17
20
18
All the `experimental` and `beta` APIs are marked with a `@note` tag in the
21
19
phpdoc section of the code.
22
20
21
+
23
22
=== Experimental
24
23
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:
26
26
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]
28
28
29
29
[source,php]
30
30
----
@@ -35,7 +35,7 @@ $params = [
35
35
$result = $client->rankEval($params);
36
36
----
37
37
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]
39
39
40
40
[source,php]
41
41
----
@@ -68,6 +68,7 @@ $client = ClientBuilder::create()->build();
68
68
$result = $client->getScriptLanguages();
69
69
----
70
70
71
+
71
72
=== Beta
72
73
73
74
There are no beta APIs in the current version of `elasticsearch-php`.
0 commit comments