Release 8.2.0

This release is compatible with the latest Elasticsearch 8.2.0.

This release includes the following fixes:

• Added the array support for text/plain #1220

Added the following new APIs 🎉 (2 stable and 6 experimental)

Stable

• Cat.componentTemplates: api spec, documentation
• Ml.getMemoryStats: api spec, documentation

Experimental

• Security.activateUserProfile: api spec, documentation
• Security.disableUserProfile: api spec, documentation
• Security.enableUserProfile: api spec, documentation
• Security.getUserProfile: api spec, documentation
• Security.suggestUserProfiles: api spec, documentation
• Security.updateUserProfileData: api spec, documentation

Release 8.1.0

This release is compatible with the latest Elasticsearch 8.1.0.

Added the following new APIs 🎉 (4 stable)

• Security.oidcAuthenticate: api spec, documentation
• Security.oidcLogout : api spec, documentation
• Security.oidcPrepareAuthentication : api spec, documentation
• Transform.resetTransform : api spec, documentation

API changes

Indices.forcemerge

Added wait_for_completion parameter.

Indices.get

Added features enum parameter, return only information on specified index features.

Ml.deleteTrainedModel

Added force boolean parameter, true if the model should be forcefully deleted.

Release 8.0.1

This release contains the following fix:

• use of NoNodeAvailableException exception in endpoints, fixing #1209 with e7d448d

Release 8.0.0

Finally 8.0.0 for Elasticsearch 8.0 is GA!!! 🥳

This new major version of elasticsearch-php contains a brand new implementation compared with 7.x. It supports PSR-7 for HTTP messages and PSR-18 for HTTP client communications. We used the elastic-transport-php library for HTTP communications.

We tried to reduce the BC breaks as much as possible with 7.x but there are some (big) differences:

• we changed the namespace, now everything is under Elastic\Elasticsearch;
• we changed the Exception model, using the namespace Elastic\Elasticsearch\Exception. All the exceptions extends the
  ElasticsearchException interface, as in 7.x;
• we changed the response type of each endpoints using an Elasticsearch response class.
  This class wraps a a PSR-7 response allowing the access of the body response
  as array or object. This means you can access the API response as in 7.x, no BC break here! 👼

You can have a look at the BREAKING_CHANGES file for more information.

We are still working on the new documentation for 8.0, in the meantime you can have a look at the README where we reported a quick start guide.

Release 8.0.0-RC2

• Added the common parameters in all the endpoints 6427f8c

Release 8.0.0-RC1

• Fixed query string in API endpoints + added a first integration test e404235
• Added AdapterOptions class and setNodePool() in ClientBuilder 9150f71
• Fixed urlencode in params, Exception in test code generation 142327b
• Improved client/server response exception messages 50de3e6

Release 8.0.0 alpha

This is an alpha release of 8.0.0. This new major version of elasticsearch-php contains a brand new implementation compared with 7.x.
It supports PSR-7 for HTTP messages and PSR-18 for HTTP client communications. We used the elastic-transport-php library for HTTP communications.

We tried to reduce the BC breaks as much as possible with 7.x but there are some (big) differences:

• we changed the namespace, now everything is under Elastic\Elasticsearch;
• we changed the Exception model, using the namespace Elastic\Elasticsearch\Exception. All the exceptions extends the
  ElasticsearchException interface, as in 7.x;
• we changed the response type of each endpoints using an Elasticsearch response class.
  This class wraps a a PSR-7 response allowing the access of the body response
  as array or object. This means you can access the API response as in 7.x, no BC break here! 👼

You can have a look at the BREAKING_CHANGES file for more information.

We are still working on the new documentation for 8.0, in the meantime you can have a look at the README where we reported a quick start guide.

Release 7.17.0

This release is compatible with the latest Elasticsearch 7.17.0 released the 1st February 2022.

It includes the following fixes and improvements:

• Allow psr/log v3 #1184

Added the following new APIs 🎉 (1 stable):

• Ml.getModelSnapshotUpgradeStats: api spec, documentation

API changes

• Ml.forecast, added body for HTTP request where query parameters can be specified in the body
• Ml.openJob, added body for HTTP request where query parameters can be specified in the body
• Transform.deleteTransform, added the timeout parameter, (time) controls the time to wait for the transform deletion
• Transform.previewTransform, added the timeout parameter, (time) Controls the time to wait for the preview
• Transform.putTransform, added the timeout parameter, (time) Controls the time to wait for the transform to start
• Transform.updateTransform, added the timeout parameter, (time) Controls the time to wait for the update
• Transform.upgradeTransforms, added the timeout parameter, (time) Controls the time to wait for the upgrade

Release 7.16.0

This release is compatible with PHP 8.1 (thanks to @karyna-tsymbal-atwix) and the latest Elasticsearch 7.16.0 released in 7th December 2021.

It includes the following fixes and improvements:

• Added support of includePortInHostHeader in ClientBuilder::fromConfig #1181
• Fixed UTF-16 issue in SmartSerializer with single unpaired surrogate in unicode escape #1179
• Replace trait with abstract class to avoid Deprecated Functionality issue in PHP 8.1 #1175

Added the following new APIs 🎉 (4 stable, and 2 experimental):

Stable

• Indices.modifyDataStream: api spec, documentation
• Migration.getFeatureUpgradeStatus: api spec, documentation
• Migration.postFeatureUpgrade: api spec, documentation
• Transform.upgradeTransforms: api spec, documentation

Experimental

• Fleet.msearch: api spec, documentation
• Fleet.search: api spec, documentation

API changes

• deleteByQuery, removed _source, _source_excludes, _source_includes parameters
• openPointInTime, the parameter keep_alive is now required. Changed the index parameter to be required (was optional)
• Nodes.stats, added the shards option to the index_metric parameter
• searchMvt, added the track_total_hits (boolean|long) parameter. Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number
• termsEnum, this API is now stable
• updateByQuery, removed _source, _source_excludes, _source_includes parameters
• Fleet.globalCheckpoints, this API is now stable
• Indices.getIndexTeamplate, changed the name parameter as string. A pattern that returned template names must match
• Ingest.putPipeline, added the if_version parameter (int). Required version for optimistic concurrency control for pipeline updates
• Ml.putTrainedModel, added the defer_definition_decompression parameter. (boolean) If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations. (Default = false)
• Monitoring.bulk, this API is now stable
• Nodes.hotThreads, added the sort parameter (enum). The sort order for 'cpu' type (default: total) (Options = cpu,total)
• Nodes.info, changed the description of metric parameter (list). A comma-separated list of metrics you wish returned. Use _all to retrieve all metrics and _none to retrieve the node identity without any additional metrics
• SearchableSnapshots.mount, this API is now stable
• SearchableSnapshots.stats, this API is now stable
• Security.clearCachedServiceTokens, this API is now stable
• Security.createServiceToken, this API is now stable
• Security.deleteServiceToken, this API is now stable
• Security.getServiceAccounts, this API is now stable
• Security.getServiceCredentials, this API is now stable
• Shutdown.deleteNode, this API is now stable
• Shutdown.getNode, this API is now stable
• Shutdown.putNode, this API is now stable
• Transform.deleteTransform, added the timeout parameter (time). Controls the time to wait for the transform deletion
• Transform.previewTransform, added the transform_id parameter (string), The id of the transform to preview.
  Added the timeout parameter (time). Controls the time to wait for the preview
• Transform.putTransform, added the timeout parameter (time). Controls the time to wait for the transform to start
• Transform.updateTransform, added the timeout parameter (time). Controls the time to wait for the update

Release 7.15.0

This release is compatible with the latest Elasticsearch 7.15.0 released in 22nd September 2021.

Added the following new APIs 🎉 (1 stable and 5 experimental):

Stable

• Security.queryApiKeys: api spec, documentation

Experimental

• Indices.diskUsage: api spec, documentation
• Indices.fieldUsageStats: api spec, documentation
• Nodes.clearRepositoriesMeteringArchive: api spec, documentation
• Nodes.getRepositoriesMeteringInfo: api spec, documentation
• SearchMvt: api spec, documentation

API changes

Ml.putJob

Added the ignore_unavailable parameter, (boolean) to ignore unavailable indexes (default: false)

Added the allow_no_indices parameter, (boolean) to ignore if the source indices expressions resolves to no concrete indices (default: true)

Added the ignore_throttled parameter, (boolean) to ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided

Added the expand_wildcards parameter, (enum) whether source index expressions should get expanded to open or closed indices

Nodes.stats

Added the shards option to the index_metric parameter

OpenPointInTime

Changed the index parameter to be required (was optional)