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)

Release 7.14.0

This release is compatible with the latest Elasticsearch 7.14.0 released in 3rd August 2021.

It includes the following fixes and improvements:

• Usage of psr/log version 2 #1154
• Update search iterators to send scroll_id inside the request body #1134
• Added the ingest.geoip.downloader.enabled=false setting for ES 5867351
• Removed phpcs for autogenerated files (endpoints) 651c57b

Added the following new APIs 🎉 (8 stable, and 1 beta):

Stable

• Ilm.migrateToDataTiers: api spec, documentation
• Ml.resetJob: api spec, documentation
• Security.samlAuthenticate: api spec, documentation
• Security.samlCompleteLogout: api spec, documentation
• Security.samlInvalidate: api spec, documentation
• Security.samlLogout: api spec, documentation
• Security.samlPrepareAuthentication: api spec, documentation
• Security.samlServiceProviderMetadata: api spec, documentation

Beta

• TermsEnum: api spec, documentation

API changes

• Msearch, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
• MsearchTemplate, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
• SearchTemplate, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
• Snapshot.get, added include_repository parameter, (boolean) whether to include the repository name in the snapshot info. Defaults to true.
• Snapshot.repositoryAnalyze, added rarely_abort_writes parameter, (boolean) whether to rarely abort writes before they complete. Defaults to 'true'.

Release 6.8.2

• Fix #1131 class naming for some endpoints used in elasticsearch-php < 6.8.
  These endpoints are: NodeAttrs, ForceMerge, MTermVectors, TermVectors
  (#1151)

Release 7.13.1

This is a patch release that includes PR #1126. It was scheduled for 7.13.0 but not included in the release.

• Added port in url for trace and logger messages #1126

Release 7.13.0

This release is compatible with the latest Elasticsearch 7.13.0 released in 25th May 2021.

It includes the following fixes and improvements:

• (DOCS) Added the HTTP meta data section #1143
• Added support for API Compatibility Header #1142
• (DOCS) Added Helpers section to PHP book #1129
• Added the API description in phpdoc section for each endpoint 9e05c81
• Usage of PHPUnit 9 only + migrated xml configurations 038b5dd

Added the following new APIs 🎉 (4 stable, 7 experimental, and 5 beta):

Stable

• Ingest.geoIpStats: api spec, documentation
• Ml.deleteTrainedModelAlias: api spec, documentation
• Ml.previewDataFrameAnalytics: api spec, documentation
• Ml.putTrainedModelAlias: api spec, documentation

Experimental

• Features.resetFeatures: api spec, documentation
• Fleet.globalCheckpoints: api spec, documentation
• Ml.findFileStructure: api spec, documentation
• SearchableSnapshots.cacheStats: api spec, documentation
• Shutdown.deleteNode: api spec, documentation
• Shutdown.getNode: api spec, documentation
• Shutdown.putNode: api spec, documentation

Beta

• Security.clearCachedServiceTokens: api spec, documentation
• Security.createServiceToken: api spec, documentation
• Security.deleteServiceToken: api spec, documentation
• Security.getServiceAccounts: api spec, documentation
• Security.getServiceCredentials: api spec, documentation

API changes

• Cat.nodes, added the include_unloaded_segments parameter (boolean). If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false).
• Ml.deleteDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.deleteTrainedModel, this API is now stable, previosuly it was beta.
• Ml.explainDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.getDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.getDataFrameAnalyticsStats, this API is now stable, previosuly it was beta.
• Ml.getTrainedModels, this API is now stable, previosuly it was beta.
• Ml.getTrainedModelsStats, this API is now stable, previosuly it was beta.
• Ml.putDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.putTrainedModel, this API is now stable, previosuly it was beta.
• Ml.startDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.stopDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Ml.updateDataFrameAnalytics, this API is now stable, previosuly it was beta.
• Nodes.stats, added include_unloaded_segments parameter (boolean). If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false).
• Snapshot.get, added index_details parameter (boolean). Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
• TextStructure.findStructure, this API is now stable, previosuly it was experimental.

Release 7.12.0

This release is compatible with the latest Elasticsearch 7.12.0 released in 23th March 2021.

It includes the following fixes and improvements:

• 136d5b9 Removed cpliakas/git-wrapper in favor of symplify/git-wrapper
• 0d81be1 Fixed warning header as array in YAML tests generator
• f69d96f Refactored TEST_SUITE with free, platinum + removed old YamlRunnerTest

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

Stable

• Eql.getStatus: api spec, documentation
• Features.getFeatures: api spec, documentation
• Logstash.deletePipeline: api spec, documentation
• Logstash.getPipeline: api spec, documentation
• Logstash.putPipeline: api spec, documentation

Experimental

• TextStructure.findStructure: api spec, documentation

API changes

• Autoscaling.deleteAutoscalingPolicy, this API is now stable, previosuly it was experimental
• Autoscaling.getAutoscalingPolicy, this API is now stable, previosuly it was experimental
• Autoscaling.putAutoscalingPolicy, this API is now stable, previosuly it was experimental
• Indices.close, added documentation for the wait_for_active_shards parameter: set to index-setting to wait according to the index setting index.write.wait_for_active_shards, or all to wait for all shards, or an integer. Defaults to 0
• Ml.findFileStructure, this API has been removed, previosuly it was experimental
• Search, added the min_compatible_shard_node parameter (string). The minimum compatible version that all shards involved in search should have for this request to be successful
• SearchableSnapshots.mount, added the storage parameter (string). Selects the kind of local storage used to accelerate searches.
  Experimental, and defaults to full_copy
• SearchableSnapshots.stats, added the level parameter (enum). Return stats aggregated at cluster, index or shard level
  (Options = cluster,indices,shards) (Default = indices)

Release 6.8.1

• Fixed missing class aliases in 6.8.0 (#1114)
• Backported #1066: fix #1058 using object instead of array in onFailure event (#1109)

Release 6.8.0

The 6.8.0 release includes all the Elasticsearch endpoints (including XPack).
We tested using the latest Elasticsearch 6.8.14 released in February 10, 2021.

NOTE: This release requires PHP 7.3+. It supports also PHP 8.

This release includes the following updates:

• Added the XPack endpoints
• Removed Travis CI in favor of Github Action

and backported the following features/PRs:

• Added X-Opaque-Id header (#952)
• Added X-Elastic-Client-Meta header (#1089)
• Added the license header (0ff5fb9)
• Support of PHP 8 (#1095 and #1063)
• Replace array_walk with array_map in Connection::getURI (#1075)
• Fix for #1064 reset custom headers (#1065)
• Replace guzzlehttp/ringphp with ezimuel/ringphp (#1102)