Packagist · #542 most downloaded on Packagist

opensearch-project/opensearch-php

2.7.134M downloads/moopensearch-project/opensearch-php ↗New releases in your daily digest, changelog included.

PHP Client for OpenSearch

Last release 24 days ago
14 Sep 2026
Release timing varies
gaps range from 2 weeks to 11 months
Most releases are documented
notes for 14 of 23 stable releases
Nothing withdrawn
no release was ever pulled
5 years old
23 releases · first in 2021

Release timeline

23 releases since 2021

202120222023202420252026

20212026

One column per quarter.

Releases

2.7.114 Sept 2026
Fixed: Refreshable AWS Credentials take2 by @SakiTakamachi in #429
What's Changed

Fixed: Refreshable AWS Credentials take2 by @SakiTakamachi in #429

Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-ci-bot in #430

Upgrade PHPStan to 2.x by @shyim in #424

Prepare release 2.7.1 by @shyim in #431

New Contributors

@SakiTakamachi made their first contribution in #429

Full Changelog: 2.7.0...2.7.1
Open source →
Additional notes
Changed

Fixed the AWS credentials handling so that expired credentials can be refreshed (#429)

Upgrade phpstan/phpstan to ^2.2 with matching 2.x phpstan-deprecation-rules, phpstan-mockery and phpstan-phpunit (#424)

2.7.08 Sept 2026Deprecated

ci: replace deprecated GitHub App token with opensearch-ci-bot by @kimpepper in #416

What's Changed

fix: handle unpaired UTF-16 surrogates in SmartSerializer by @k-anz in #403
Add issues write permission to untriaged label workflow by @shreyah963 in #406
Pin actions/github-script to exact commit SHA by @shreyah963 in #407
Pin GitHub Actions to commit SHAs by @Divyaasm in #408
Onboard new backport-pr re-usable github workflow (opensearch-php) by @peterzhuamazon in #410
ci: update actions by @shyim in #411
ci: drop EOL OpenSearch 1.x and legacy Elasticsearch integration tests by @kimpepper in #415
chore: upgrade phpunit/phpunit to ^11.5 by @kimpepper in #414
docs: fix CHANGELOG links flagged by link checker by @kimpepper in #417
ci: replace deprecated GitHub App token with opensearch-ci-bot by @kimpepper in #416
fix: accept any callable as SigningClientFactory provider by @shyim in #405
Resolve LGPL license incompile with Apache License 2.0 by @yyfamazon in #419
fix: update OpenAPI spec download location by @kimpepper in #420
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-ci-bot in #421
Revert "Resolve LGPL license incompile with Apache License 2.0 (#419)" by @andrross in #422
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-ci-bot in #423
Widen guzzlehttp/psr7 dev constraint to support Guzzle 8 (#412) by @kimpepper in #425
Prepare release 2.7.0 by @kimpepper in #426

New Contributors

@k-anz made their first contribution in #403
@shreyah963 made their first contribution in #406
@Divyaasm made their first contribution in #408
@peterzhuamazon made their first contribution in #410
@yyfamazon made their first contribution in #419
@opensearch-ci-bot made their first contribution in #421
@andrross made their first contribution in #422

Full Changelog: 2.6.0...2.7.0

Open source →

Additional notes

Changed

Replace deprecated GitHub App token with opensearch-ci-bot in CI workflows (#416)
Upgrade phpunit/phpunit to ^11.5 (#414)
Widen guzzlehttp/psr7 dev dependency constraint to ^2.8.0 || ^3.0.0 and bump aws/aws-sdk-php dev dependency to ^3.394.9 to support Guzzle 8 (#412)

Deprecated

Passing a CredentialProvider instance to SigningClientFactory is deprecated; pass a callable instead (#404)

Removed

Drop CI integration testing against EOL OpenSearch 1.x and legacy Elasticsearch OSS 7.10.0 (#415)

Fixed

Fix SmartSerializer throwing JsonException on JSON with unpaired UTF-16 surrogate escape sequences produced by search highlighting (#403)
Accept any callable as the provider argument of SigningClientFactory so AWS SDK credential providers like CredentialProvider::sso() and CredentialProvider::assumeRole() can be used (#404)
Update OpenAPI spec download location to https://api-spec.opensearch.org/opensearch-openapi.yaml (#420)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@305c445
Updated opensearch-php APIs to reflect opensearch-api-specification@412f39c
Updated opensearch-php APIs to reflect opensearch-api-specification@59c22e5
Updated opensearch-php APIs to reflect opensearch-api-specification@b8c2a41

2.6.024 Mar 2026

feat: Update php scripts to symfony commands by @kimpepper in #394

What's Changed

feat: Update php scripts to symfony commands by @kimpepper in #394
fix: error thrown trying to parse type for param docs by @kimpepper in #395
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #396
feat: Add param array shapes (2) by @kimpepper in #398
feat: Convert legacy templates to twig by @kimpepper in #399
build: Prepare 2.6.0 release by @kimpepper in #400

Full Changelog: 2.5.1...2.6.0

Open source →

Additional notes

Added

Update docblocks to define array shapes (#398)

Changed

Replace php scripts with Symfony commands (#394)
Update minimum PHP version to 8.2 and add PHP 8.5 testing (#394)
Switch from legacy templates to twig (#399)

Fixed

fix: error thrown trying to parse type for param docs (#395)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@a2b4f35
Updated opensearch-php APIs to reflect opensearch-api-specification@8d5d6d5
Updated opensearch-php APIs to reflect opensearch-api-specification@cbb07cd

Open source →

2.5.116 Jan 2026

Back to dev by @kimpepper in #375

What's Changed

Back to dev by @kimpepper in #375
Support Symfony 8 by @nikow13 in #381
docs: Replace newline with a space by @kimpepper in #382
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #377
fix: Allow params with the name type by @kimpepper in #384
Retries in logging message in GuzzleRetryDecider are off by one by @acha5066 in #386
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #388
Prepare 2.5.1 release by @kimpepper in #387

New Contributors

@nikow13 made their first contribution in #381

Full Changelog: 2.5.0...2.5.1

Open source →

Additional notes

Added

Support Symfony 8 (#381)

Fixed

Retries in logging message in GuzzleRetryDecider are off by one (#386)
Fix newlines in docs (#382)
Allow URL params with the name type (#384)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@2954600
Updated opensearch-php APIs to reflect opensearch-api-specification@0fbd80c
Updated opensearch-php APIs to reflect opensearch-api-specification@6124008

Open source →

2.5.014 Nov 2025

Back to dev by @kimpepper in #365

What's Changed

Back to dev by @kimpepper in #365
Move health check to shared action by @kimpepper in #366
Test lowest allowed version of dependencies by @kimpepper in #367
Upgrade from phpunit v9 to v10 by @kimpepper in #371
fix: ID is being double encoded by @kimpepper in #368
Simplify url encoding by @kimpepper in #370
Prepare 2.5.0 release by @kimpepper in #372

Full Changelog: 2.4.6...2.5.0

Open source →

Additional notes

Changed

Moved duplicate health check workflow step to a shared action (#366)
Bump composer dependencies and add --prefer-lowest to the test matrix (#367)
Upgrade from phpunit v9 to v10 (#371)
Simplify logic for url param encoding (#370)

Fixed

ID is being double encoded (#360)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@db59af1

Open source →

2.4.610 Nov 2025

Back to dev version by @kimpepper in #352

What's Changed

Back to dev version by @kimpepper in #352
#353: Add support for Guzzle logging middleware by @ossobuffo in #354
Fix(SearchResponseIterator): Move scroll_id to body by @umaarov in #356
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #357
task: Update lycheeverse/lychee-action to v2 by @kimpepper in #358
fix: lychee build by @kimpepper in #359
Switch to actions/create-github-app-token by @kimpepper in #362
Update OpenSearch version test matrix and add v3 by @kimpepper in #361
Prepare 2.4.6 release by @kimpepper in #363

New Contributors

@ossobuffo made their first contribution in #354
@umaarov made their first contribution in #356

Full Changelog: 2.4.5...2.4.6

Open source →

Additional notes

Added

Added support for injecting Guzzle middleware (#353)

Changed

Switch from deprecated tibdex/github-app-token to official actions/create-github-app-token #362
Update OpenSearch version test matrix #361

Fixed

Fixed scrolling triggers deprecation error (#163, #356)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@c7f7cff

Open source →

2.4.45 Aug 2025

Back to dev by @kimpepper in #324

What's Changed

Back to dev by @kimpepper in #324
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #325
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #326
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #327
Reduce distribution size by actualizing .gitattributes' export ignore section by @savinmikhail in #330
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #328
fix: update generator to encode url parameters by @shyim in #335
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #332
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #336
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #338
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #340
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #341
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #342
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot[bot] in #343
Stepping down from project maintainers. by @dblock in #344
Fix error when content_type is NULL by @davidwindell in #345
prepare release by @shyim in #346

New Contributors

@savinmikhail made their first contribution in #330
@davidwindell made their first contribution in #345

Full Changelog: 2.4.3...2.4.4

Open source →

Additional notes

Added

Added URL encoding to all endpoint parameters (#335)

Fixed

Reduce distribution size by actualizing .gitattributes' export ignore section (#330)
Fix error when content_type is NULL (#345)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@8cb2e8f
Updated opensearch-php APIs to reflect opensearch-api-specification@a8ea65d
Updated opensearch-php APIs to reflect opensearch-api-specification@acebe7b
Updated opensearch-php APIs to reflect opensearch-api-specification@d4eab1a
Updated opensearch-php APIs to reflect opensearch-api-specification@3d086c0
Updated opensearch-php APIs to reflect opensearch-api-specification@bddc88a
Updated opensearch-php APIs to reflect opensearch-api-specification@0e87c7c
Updated opensearch-php APIs to reflect opensearch-api-specification@0d01e0d
Updated opensearch-php APIs to reflect opensearch-api-specification@fc5e888

2.4.310 Mar 2025

Back to dev version by @kimpepper in #305

What's Changed

Back to dev version by @kimpepper in #305
Fix changelog updater by @kimpepper in #306
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #302
Replace array by iterable in return type. Fix #307 by @romainruaud in #308
Fix legacy options leaking into request headers by @kimpepper in #310
Updated affiliation for @dblock. by @dblock in #311
Update performRequest return type to iterable by @kimpepper in #313
Make EndpointFactory and optional Client constructor param by @kimpepper in #315
Fix options not being passed to legacy transport by @kimpepper in #316
Adds a AwsSigningHttpClientFactory by @kimpepper in #314
Fix json deserialization error by @tn2222 in #320
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #317
Prepare 2.4.3 release by @kimpepper in #322

New Contributors

@romainruaud made their first contribution in #308
@tn2222 made their first contribution in #320

Full Changelog: 2.4.2...2.4.3

Open source →

Additional notes

Added

Added auth_aws option to GuzzleClientFactory and SymfonyClientFactory (#314)

Changed

Updated Client constructor to make EndpointFactory an optional parameter (#315)

Fixed

Fixed checking for content type in JSON deserialization (#318)
Fixed mismatch in return types between Client::performRequest() and Transport::sendRequest() (#307)
Fixed legacy client options being passed as headers (#301)
Fixed endpoint options not being passed to legacy transport (#296)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@89cd8f3
Updated opensearch-php APIs to reflect opensearch-api-specification@5ed668d

Open source →

2.4.03 Feb 2025Deprecated

Add phpstan deprecation rules by @kimpepper in #258

What's Changed

Add --warning-mode none when assembling OpenSearch in CI by @TimWolla in #231
Run unit tests with PHP 8.3 and 8.4 on CI by @TimWolla in #229
Update GitHub Actions by @TimWolla in #230
Fix: build OpenSearch with the correct Java/Gradle combination. by @dblock in #234
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #223
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #235
Return static from fluid setters by @kimpepper in #236
Require minimum PHP 8.0 by @kimpepper in #239
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #238
Replace callable with Endpoint factory by @kimpepper in #237
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #241
Psr interfaces by @kimpepper in #233
Restore exception behavior for backwards compatibility by @kimpepper in #245
Adds a test for the signing client decorator by @kimpepper in #252
Adding @kimpepper as a co-maintainer. by @dblock in #249
Fix missing required $model_id param in GetModel by @kimpepper in #255
Add decorator tests for guzzle and symfony by @kimpepper in #256
Handle HTTP exceptions in HttpTransport by @kimpepper in #254
Added optional headers to the AWS SigningDecorator. by @dblock in #253
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #243
Add phpstan deprecation rules by @kimpepper in #258
Add phpstan baseline by @kimpepper in #259
Add phpstan/phpstan-phpunit by @kimpepper in #263
Deprecate unused classes by @kimpepper in #264
Update deprecation message to specify version 2.4.0 not 2.3.2 by @kimpepper in #265
Bump java version to 21 for unreleased opensearch tests by @kimpepper in #267
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #268
Updated opensearch-php to reflect the latest OpenSearch API spec by @opensearch-trigger-bot in #269
Fix JDK version for OpenSearch 1.x release branch by @reta in #272
Adds http client factories by @kimpepper in #271
Deprecate namespaces no longer in API spec by @kimpepper in #270
Add php cs fixer rule to remove unused imports by @kimpepper in #275
Serialize boolean query string params as strings by @kimpepper in #273
Deprecate remaining exceptions in \OpenSearch\Common\Exceptions and replace with new ones by @kimpepper in #274
Remove ksort for request params by @kimpepper in #276
Preparing for 2.4.0 release by @kimpepper in #277
Reduce the number of approvers for release to 1. by @dblock in #280

New Contributors

@kimpepper made their first contribution in #236
@reta made their first contribution in #272

Full Changelog: 2.3.1...2.4.0

Open source →

Additional notes

Added

Generate endpoints from OpenSearch API Specification (#194)
Added workflow for automated API update using OpenSearch API specification (#209)
Added samples (#218)
Added support for PHP 8.3 and 8.4 (#229)
Added a Docker Compose config file for local development (#245)
Added a test for the AWS signing client decorator (#252)
Added PHPStan Deprecation rules and baseline (#263)
Added PHPStan PHPUnit extensions and rules (#263)
Added Guzzle and Symfony HTTP client factories (#271)
Added 'colinodell/psr-testlogger' as a dev dependency (#271)

Changed

Switched to PSR Interfaces (#233)
Increased PHP min version to 8.1 (#233)
Increased min version of ezimuel/ringphp to ^1.2.2 (225)
Changed fluent setters to return static (#236)

Deprecated

Passing a callable to \OpenSearch\ClientBuilder::setEndpoint() is deprecated and replaced with passing an EndpointFactory to \OpenSearch\ClientBuilder::setEndpointFactory() (#237)
Connections, Connection pools and Selectors are deprecated. Use a PSR HTTP Client that supports retries instead (#245)
The following namespaces have been deprecated and will be removed in 3.0.0: 'async_search', 'searchable_snapshots', 'ssl', 'data_frame_transform_deprecated', 'monitoring' (#270)
A number of exceptions under \OpenSearch\Common\Exceptions are deprecated and moved to \OpenSearch\Exception (#274)

Removed

Removed support for PHP 7.3, 7.4 and 8.0 (#233)
Removed support for async requests which were never actually working (#233)

Fixed

Fixed PHP 8.4 deprecations (#229)
Fixed outdated tests (#245)

Updated APIs

Updated opensearch-php APIs to reflect opensearch-api-specification@5697cbd
Updated opensearch-php APIs to reflect opensearch-api-specification@22483a2
Updated opensearch-php APIs to reflect opensearch-api-specification@b9dcb25
Updated opensearch-php APIs to reflect opensearch-api-specification@9df46f8
Updated opensearch-php APIs to reflect opensearch-api-specification@592336a
Updated opensearch-php APIs to reflect opensearch-api-specification@799d046
Updated opensearch-php APIs to reflect opensearch-api-specification@1422af3
Updated opensearch-php APIs to reflect opensearch-api-specification@2395cb4
Updated opensearch-php APIs to reflect opensearch-api-specification@ebe0f8a
Updated opensearch-php APIs to reflect opensearch-api-specification@398481e
Updated opensearch-php APIs to reflect opensearch-api-specification@6bb1fed
Updated opensearch-php APIs to reflect opensearch-api-specification@07e329e
Updated opensearch-php APIs to reflect opensearch-api-specification@1db1840
Updated opensearch-php APIs to reflect opensearch-api-specification@cb320b5

2.3.024 Apr 2024

Added a GitHub workflow for verifying CHANGELOG

Added

Added a GitHub workflow for verifying CHANGELOG (#92)
Added class docs generator (#96)
Added support for Amazon OpenSearch Serverless SigV4 signing (#119)
Added includePortInHostHeader option to ClientBuilder::fromConfig (#118)
Added the RefreshSearchAnalyzers endpoint (#152)
Added support for format parameter to specify the sql response format (#161)
Added ml-commons model, model group and connector APIs (#170)
Added support for sending raw JSON requests (#171)
Added PHP 8.2 support (#87)
Added Windows and MacOS support (#100)
Added code coverage reporting (#100)
Added support for a custom signing service name for AWS SigV4 (#117)
Added support for OpenSearch 2.12 and 2.13 (#180)
Added release automation to publish to packagist (#183)
Added @saimedhi to opensearch-php maintainers (#215)

Fixed

Fixed backport workflow when tag is applied before closing PR (#131)
Fixed host urls with trailing slash in the url (#130)
Fixed point-in-time APIs (#142)
Fixed basic authentication being overridden by connection params in ClientBuilder (#160)
Fixed PHP warning in Connection::tryDeserializeError() for some error responses (#167)

Open source →