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)

Release 7.11.0

This release is compatible with the latest Elasticsearch 7.11.0 released in 10th February 2021.
This is the first release to be compatible with PHP 8.

It includes the following fixes and improvements:

• #1089 Added the X-Elastic-Client-Meta header which is used by Elastic Cloud
  and can be disabled with ClientBuilder::setElasticMetaHeader(false)
• #1075 Replaced array_walk with array_map in Connection::getURI for PHP 8
  compatibility
• #1069 Remove unnecessary InvalidArgumentExceptions
• #1063 Introducing PHP 8 compatibility
• #1062 Replace Sami by Doctum and fix .gitignore

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

Stable

• AsyncSearch.status: api spec, documentation
• Indices.migrateToDataStream: api spec, documentation
• Indices.promoteDataStream: api spec, documentation
• Ml.upgradeJobSnapshot: api spec, documentation
• Rollup.rollup: api spec, documentation
• Watcher.queryWatches: api spec, documentation

Experimental

• Autoscaling.getAutoscalingCapacity: api spec, documentation

API changes

• Cat.tasks, the parameters node_id and parent_task has been changed in nodes and parent_task_id
• Cluster.deleteComponentTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Cluster.existsComponentTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Cluster.getComponentTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Cluster.putComponentTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.deleteIndexTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.existsIndexTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.getIndexTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.putIndexTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.simulateIndexTemplate, this API has become STABLE, it was EXPERIMENTAL before
• Indices.simulateTemplate, this API has become STABLE, it was EXPERIMENTAL before
• DataFrameTransformDeprecated.getTransform (BETA API), added the exclude_generated parameter: (boolean) Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster (Default = false)
• Eql.delete, this API has become STABLE, it was BETA before
• Eql.get, this API has become STABLE, it was BETA before
• Eql.search, this API has become STABLE, it was BETA before
• Indices.deleteDataStream, added expand_wildcards parameter: (enum) Whether wildcard expressions should get expanded
  to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open)
• Indices.getDataStream, added expand_wildcards parameter: (enum) Whether wildcard expressions should get expanded
  to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open)
• Ml.deleteDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.deleteTrainedModel, this API has become BETA, it was EXPERIMENTAL before
• Ml.explainDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.getDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.getDatafeeds, added the exclude_generated parameter: (boolean) Omits fields that are illegal to set on data frame
  analytics PUT (Default = false)
• Ml.getJobs, added the exclude_generated parameter: (boolean) Omits fields that are illegal to set on job PUT
  (Default = false)
• Ml.getTrainedModels, this API has become BETA, it was EXPERIMENTAL before. Added the exclude_generated paremeter: (boolean) Omits fields that are illegal to set on model PUT (Default = false). Removed the for_export parameter
• Ml.getTrainedModelsStats, this API has become BETA, it was EXPERIMENTAL before
• Ml.putDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.putTrainedModel, this API has become BETA, it was EXPERIMENTAL before
• Ml.startDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.stopDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Ml.updateDataFrameAnalytics, this API has become BETA, it was EXPERIMENTAL before
• Transform.getTransform, added the exclude_generated parameter: (boolean) Omits fields that are illegal to set on transform
  PUT (Default = false)

Release 7.10.0

This release is compatible with the latest Elasticsearch 7.10.0 released in 11th November 2020.

It includes the following fixes and improvements:

• Fixed ClientBuilder::fromConfig allowing multiple function parameters (e.g. setApiKey) #1076
• Refactored the YAML tests using generated PHPUnit code 85fadc2

Added the following new APIs 🎉:

Stable

• openPointInTime: api spec, documentation
• closePointInTime: api spec, documentation
• Security.clearApiKeyCache: api spec, documentation
• Security.grantApiKey: api spec, documentation

API changes

• Bulk: added the require_alias parameter = (boolean) Sets require_alias for all incoming documents. Defaults to unset (false).

• Index: added the require_alias parameter = (boolean) When true, requires destination to be an alias. Default is false.

• Update: added the require_alias parameter = (boolean) When true, requires destination is an alias. Default is false.

• Cat.mlDatafeeds: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no datafeeds.
  This includes _all string or when no datafeeds have been specified.

• Cat.mlJobs: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no datafeeds.
  This includes _all string or when no datafeeds have been specified.

• Ml.closeJob: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no jobs.
  This includes _all string or when no jobs have been specified.

• Ml.getDatafeeds: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no datafeeds.
  This includes _all string or when no datafeeds have been specified.

• Ml.getJobStats: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no jobs.
  This includes _all string or when no jobs have been specified.

• Ml.getJobs: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no jobs.
  This includes _all string or when no jobs have been specified.

• Ml.getOverallBuckets: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no jobs.
  This includes _all string or when no jobs have been specified.

• Ml.getTrainedModels (EXPERIMENTAL API): added the include parameter = (string) A comma-separate list of fields to optionally include.
  Valid options are definition and total_feature_importance. Default is none.

• Ml.stopDatafeed: added the allow_no_match parameter = (boolean) Whether to ignore if a wildcard expression matches no datafeeds.
  This includes _all string or when no datafeeds have been specified.

Release 7.9.1

• Fixed using object instead of array in onFailure transport event #1066
• Fixed reset custom header after endpoint call #1065
• Show generic error messages when server returns no response #1056

Release 7.9.0

This release is compatible with the latest Elasticsearch 7.9.0 released in 18th August 2020.

It includes the following fixes:

• Moved scroll_id into body for search operations in the documentation #1052
• Fixed PHP 7.4 preloading feature for autoload.php #1051
• Improved message of JSON errors using json_last_error_msg() #1045
• Make ClientBuilder override possible, using static instead of self #1036

Added the following new APIs 🎉:

Stable

• A new namespace DanglingIndices with following endpoints:

  • DanglingIndices.listDanglingIndices: api spec, documentation
  • DanglingIndices.importDanglingIndex: api spec, documentation
  • DanglingIndices.deleteDanglingIndex: api spec, documentation

• Indices.addBlock: api spec, documentation

• Security.clearCachedPrivileges: api spec, documentation

• Indices.dataStreamsStats: api spec, documentation

Beta

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.

• Eql.get: api spec, documentation

• Eql.delete: api spec, documentation

Experimental

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.

• Ml.updateDataFrameAnalytics: api spec, documentation

• Indices.resolveIndex: api spec, documentation

• Indices.simulateTemplate: api spec, documentation

API changes

• Indices.putMapping: added the write_index_only parameter = (boolean) When true, applies mappings only to the write index of an alias or data stream (Default = false)

• Ml.deleteExpiredData: added the following parameters:

  • job_id (string) The ID of the job(s) to perform expired data hygiene for
  • requests_per_second (number) The desired requests per second for the deletion processes
  • timeout (time) How long can the underlying delete processes run until they are canceled
  • body (array) deleting expired data parameters

• Ml.forecast: added the parameter max_model_memory (string) The max memory able to be used by the forecast. Default is 20mb.

• Ml.getCategories: added the parameter partition_field_value (string) Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled

• Ml.getTrainedModels: added the parameter for_export (boolean) Omits fields that are illegal to set on model PUT (Default = false)

• Xpack.info: added the parameter accept_enterprise (boolean) If an enterprise license is installed, return the type and mode as 'enterprise' (default: false)

• Indices.deleteDataStream: changed the name parameter from string to list (a comma-separated list of data streams to delete; use * to delete all data streams)

• Indices.getDataStream (name changed from getDataStreams): changed the name parameter from string to list (a comma-separated list of data streams to get; use * to get all data streams)

Release 7.4.2

This release fixes #1048 and #1017 issues with indexing failure for item IDs that contain slashes.