Skip to content

Commit

Permalink
Merge pull request #1027 from szabosteve/7.x.rev.ci.eb
Browse files Browse the repository at this point in the history
[DOCS] Fine-tunes experimental and beta APIs page in PHP client book
  • Loading branch information
szabosteve authored Jun 9, 2020
2 parents d207c43 + 4ea7fe6 commit aa92be3
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions docs/experimental-beta-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
[[experimental_and_beta_apis]]
== Experimental and beta APIs

The PHP client offers also `experimental` and `beta` APIs for Elasticsearch.

The Elasticsearch API are marked using the following convention:

- **Stable** APIs should be safe to use extensively in production.
Any breaking changes to these APIs should only occur in major versions and
will be clearly documented in the breaking changes documentation for that
release.
- **Beta** APIs are on track to become stable and permanent features.
Caution should be exercised in their use since it is possible we’d have to make
a breaking change to these APIs in a minor version, but we’ll avoid this
wherever possible.
The PHP client offers also `experimental` and `beta` APIs for {es}.

The {es} APIs are marked using the following convention:

- **Stable** APIs should be safe to use extensively in production. Any breaking
changes to these APIs should only occur in major versions and will be
documented in the breaking changes documentation for that release.
- **Beta** APIs are on track to become stable and permanent features. Use them
with caution because it is possible that breaking changes are made to these
APIs in a minor version.
- **Experimental** APIs are just that - an experiment. An experimental API might
have breaking changes in any future version, or it might even be removed
entirely.

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


=== Experimental

The experimental APIs included in the current version of `elasticsearch-php` are:
The experimental APIs included in the current version of `elasticsearch-php`
are:

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

[source,php]
----
Expand All @@ -35,7 +35,7 @@ $params = [
$result = $client->rankEval($params);
----

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

[source,php]
----
Expand Down Expand Up @@ -68,6 +68,7 @@ $client = ClientBuilder::create()->build();
$result = $client->getScriptLanguages();
----


=== Beta

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

0 comments on commit aa92be3

Please sign in to comment.