Inspired from Keep a Changelog
- Bump
io.github.classgraph:classgraphfrom 4.8.180 to 4.8.184 (#1703, #1759) - Bump
org.junit:junit-bomfrom 5.13.3 to 6.0.2 (#1704, #1746, #1780, #1856) - Bump
org.opensearch.gradle:build-toolsfrom 3.2.0-SNAPSHOT to 3.5.0-SNAPSHOT (#1714, #1756, #1841) - Bump
org.ajoberstar.grgit:grgit-gradlefrom 5.3.2 to 5.3.3 (#1723) - Bump
org.apache.httpcomponents.core5:httpcore5from 5.3.4 to 5.4 (#1726, #1733, #1815) - Bump
org.owasp.dependencycheckfrom 12.1.3 to 12.2.0 (#1735, #1742, #1754, #1765, #1796, #1854) - Bump
org.apache.httpcomponents.client5:httpclient5from 5.5 to 5.6 (#1740, #1844) - Bump
gradle-wrapperfrom 9.2.0 to 9.3.1 (#1862, #1864)
- Fix formatting of the main method to run for various samples (#1749)
- Fix NPE when null ObjectBuilder is accessed (#1717)
- Added BulkIngester helper for efficient bulk operations with buffering, retries, and backpressure. Ported from elasticsearch-java (commit e7120d4) (#1809)
3.5.0 - 01/15/2026
- Fix formatting of the main method to run for various samples (#1749)
- Fix NPE when null ObjectBuilder is accessed (#1717)
- Added BulkIngester helper for efficient bulk operations with buffering, retries, and backpressure. Ported from elasticsearch-java (commit e7120d4) (#1809)
- Added equals and hashCode implementation to JsonDataImpl (#1803)
3.4.0 - 12/15/2025
- Fixed an issue where
AwsSdk2Transportwould create a defaultJacksonJsonpMapperon every instantiation even if a mapper was already provided, which could cause issues with Jackson module resolution (#1788) - Fixed the regression introduced in the OpenSearch OpenAPI spec (#1794)
3.3.0 - 10/29/2025
- Added decommission awareness & weighted routing operations (#1632)
- Added support for the
ltrnamespace (#1689) - Added support for the
geospatialnamespace (#1690) - Added support for the
knnnamespace (#1693) - Added getter for retrieve all nodes along with their state (#1698)
- Added support for the
search_relevancenamespace (#1748)
- Bump
io.github.classgraph:classgraphfrom 4.8.180 to 4.8.181 (#1703) - Bump
org.junit:junit-bomfrom 5.13.3 to 5.13.4 (#1704)
3.2.0 - 07/10/2025
- Added support for Index Management plugin APIs (#1604)
- Added support for the security plugin APIs (#1601)
- Added Jackson
ObjectMappermodule auto-detection (#1643) - Added support for the
ingestionnamespace (#1663)
- Bump
org.owasp.dependencycheckfrom 12.1.1 to 12.1.3 (#1608, #1607, #1623) - Bump
org.junit:junit-bomfrom 5.13.0 to 5.13.2 (#1606, #1650, #1665) - Bump
org.ajoberstar.grgit:grgit-gradlefrom 5.3.0 to 5.3.2 (#1621) - Bump
io.github.classgraph:classgraphfrom 4.8.179 to 4.8.180 (#1651)
- Changed the type of the properties in DocStatus from integer to Long to resolve the integer overflow issue (#1644)
- Fixed building instances of
Explanationby makingdetailsoptional (#1620) - Fixed
ApacheHttpClient5Transportnot honoring connect & socket timeouts configured onConnectionConfig(#1662)
2.26.0 - 07/10/2025
- Added Jackson
ObjectMappermodule auto-detection (#1643)
- Bump
org.owasp.dependencycheckfrom 12.1.1 to 12.1.3 (#1608, #1607, #1623) - Bump
org.junit:junit-bomfrom 5.13.0 to 5.13.2 (#1606, #1650, #1665) - Bump
org.ajoberstar.grgit:grgit-gradlefrom 5.3.0 to 5.3.2 (#1621) - Bump
io.github.classgraph:classgraphfrom 4.8.179 to 4.8.180 (#1651)
- Fixed
ApacheHttpClient5Transportnot honoring connect & socket timeouts configured onConnectionConfig(#1662)
3.1.0 - 06/04/2025
- Added support for the
templatequery type (#1586) - Added support for Search Shards request
sliceproperty (#1586) - Added support for the
score-ranker-processorphase results processor (#1594)
- Bump
org.apache.httpcomponents.client5:httpclient5from 5.4.4 to 5.5 (#1578) - Bump
org.junit:junit-bomfrom 5.12.2 to 5.13.0 (#1587)
2.25.0 - 06/03/2025
- Added support for the
templatequery type (#1586) - Added support for Search Shards request
sliceproperty (#1586) - Added support for ML tool attributes (#1594)
- Added support for the
score-ranker-processorphase results processor (#1594)
- Bump
org.junit:junit-bomfrom 5.12.2 to 5.13.0 (#1587)
- Fixed ScoreCombination's
parametersstructure (#1594)
3.0.0 - 05/16/2025
- As part of efforts to re-generate the client from our OpenAPI specification there have been numerous corrections and changes that resulted in breaking changes. Please refer to UPGRADING.md for a complete list of these breakages and any relevant guidance for upgrading to this version of the client.
- Document HTTP/2 support (#330)
- Bumps
org.eclipse.parsson:parssonfrom 1.1.6 to 1.1.7 - Bumps
org.hamcrest:hamcrestfrom 2.2 to 3.0 - Bumps
com.github.jk1.dependency-license-reportfrom 2.8 to 2.9 - Bump
com.carrotsearch.randomizedtesting:randomizedtesting-runnerfrom 2.8.2 to 2.8.3 (#1487) - Bump
org.opensearch.gradle:build-toolsfrom 3.0.0-alpha1-SNAPSHOT to 3.1.0-SNAPSHOT (#1543)
- Migrate client transports to Apache HttpClient / Core 5.x (#246)
- Changed SearchAfter of SearchRequest type to FieldValue instead of String (#769)
- Changed type of
DanglingIndex'screationDateMillisfield fromStringtolong(#1124) - Changed type of
ShardStatistics'stotal,successful,failed&skippedfields fromNumbertoint/Integer(#1158) - Unified
tasks.Infoandtasks.Stateclasses intotasks.TaskInfo(#1187) - Changed type of
Hit'ssortfield fromList<String>toList<FieldValue>(#1225) - Changed type of
MultisearchBody'ssearchAfterfield fromList<String>toList<FieldValue>(#1225)
- Deprecate RestClientTransport (#536)
- Removed the
featuresandshutdownnamespaces as they're not supported by OpenSearch (#1361) - Removed the
indices.diskUsageoperation as it's not supported by OpenSearch (#1361) - Removed the
ingest.geoIpStatsoperation as it's not supported by OpenSearch (#1375) - Removed the
indices.getUpgradeandindices.upgradeoperations as they're not supported by OpenSearch (#1377) - Removed the
termsEnumoperation as it's not supported by OpenSearch (#1377)
2.24.0 - 05/16/2025
- Bump
org.apache.httpcomponents.client5:httpclient5from 5.4.3 to 5.4.4 (#1544)
- Changed
StopTokenFilter'sstopwordsfield to no longer be required (#1551)
2.23.0 - 04/17/2025
- Bump
org.owasp.dependencycheckfrom 12.0.2 to 12.1.1 (#1440, #1514) - Bump
org.junit:junit-bomfrom 5.12.0 to 5.12.2 (#1486, #1525) - Bump
org.apache.httpcomponents.client5:httpclient5from 5.4.2 to 5.4.3 (#1506) - Bump
org.apache.httpcomponents.core5:httpcore5-h2from 5.3.3 to 5.3.4 (#1498) - Bump
org.apache.httpcomponents.core5:httpcore5from 5.3.3 to 5.3.4 (#1497)
- Fixed ClassCastException in extractAndWrapCause when handling ExecutionException (#1483)
- Fixed getting cluster & node stats and node info against AOS due to missing properties (#1520, #1521)
2.22.0 - 03/05/2025
- Added
toBuilder()andBuilder.copy()methods to all generated classes (#1300) - Added support for additional ML APIs (#1443)
- Added support for the Search Pipeline APIs (#1442)
- Added support for
simple_patternandsimple_pattern_splittokenizers (#1448, #1451) - Added support for the Search response
phase_tookfield (#1449) - Added support for
GeoDistanceSort'snestedandvalidation_methodfields (#1470)
- Bump
org.junit:junit-bomfrom 5.11.4 to 5.12.0 (#1456)
- Changed abstract builders visibility to public (#1464)
2.21.0 - 02/14/2025
- Added support for
GeoDistanceQuery'signore_unmappedproperty (#1430) - Added support for docvalue_fields in msearch (#1429)
- Bump
commons-logging:commons-loggingfrom 1.3.4 to 1.3.5 (#1418)
- Fixed serialization of
KnnQuery'smethod_parametersproperty (#1427) - Fixed deserializing
GeoValidationMethodenum values when uppercase (#1431)
2.20.0 - 02/04/2025
- Added support for
KnnQuery'sexpand_nested_docs,method_parametersandrescoreproperties (#1407)
- Bump
org.junit:junit-bomfrom 5.11.3 to 5.11.4 (#1367) - Bumps
org.apache.httpcomponents.client5:httpclient5from 5.4 to 5.4.2 (#1401) - Bumps
org.apache.httpcomponents.core5:httpcore5from 5.3 to 5.3.3 (#1383, #1402) - Bump
org.owasp.dependencycheckfrom 11.1.1 to 12.0.2 (#1381, #1393, #1399)
- Fixed serialization of
time_zonefield inCompositeDateHistogramAggregationSource(#1362)
2.19.0 - 12/12/2024
- Added support for
IcuCollationKeywordProperty'scountry,languageandvariantproperties (#1321)
- Bumps
org.junit:junit-bomfrom 5.10.2 to 5.11.3 - Bump
com.carrotsearch.randomizedtesting:randomizedtesting-runnerfrom 2.8.1 to 2.8.2 (#1343) - Bump
org.owasp.dependencycheckfrom 11.1.0 to 11.1.1 (#1344)
- Fixed
IcuCollationDecomposition's variants to align with those supported by OpenSearch (#1321) - Fixed don't invoke the mapper's serialize method for the RangeQuery JsonData raw value #1309
- Fixed an issue where
FieldSortwas not implementingSortOptionsVariant(#1323) - Fixed
GetSnapshotResponsedeserialization (#1299) - Fixed
CreateSnapshotResponsedeserialization when wait_for_completion is false (#1332) - Fixed serialization of nested aggregates under
SingleBucketAggregateBase(#1350)
2.18.0 - 11/19/2024
- Added support for disabling typed keys serialization (#1296)
- Added support for the
batch_sizeparam on thetext_embeddingprocessor (#1298)
- Bump
io.github.classgraph:classgraphfrom 4.8.177 to 4.8.179 (#1302)
- Changed AwsSdk2Transport to pre-emptively throw an exception when using AWS SDK's ApacheHttpClient to make an unsupported DELETE/GET request with a body (#1256)
2.17.0 - 11/05/2024
- Added support for
KnnVectorProperty'scompression_level,data_type,mode&space_typeproperties (#1255)
- Bumps
org.apache.httpcomponents.core5:httpcore5-h2from 5.3 to 5.3.1 - Bumps
org.owasp.dependencycheckfrom 10.0.2 to 11.1.0
- Fixed
UndeployModelResponsedeserialization (#1257)
2.16.0 - 10/22/2024
- Added
minScoreandmaxDistancetoKnnQuery(#1166) - Added
minScoreandmaxDistancetoNeuralQuery(#1235)
- Bumps
org.ajoberstar.grgit:grgit-gradlefrom 5.2.2 to 5.3.0
- Fixed deserializing
GeoBoundsAggregatewhenboundsis not returned by OpenSearch (#1238)
2.15.0 - 10/17/2024
- Added
hashCodeandequalsimplementations to generated code (#312) - Added
sortValstoHitto allow retrieving non-string sort values (#1224) - Added
searchAfterValstoMultisearchBodyto allow passing arbitraryFieldValues tosearch_after(#1224)
- Bumps
org.junit:junit-bomfrom 5.10.3 to 5.11.1 - Bumps
org.apache.httpcomponents.core5:httpcore5-h2from 5.2.5 to 5.3 - Bumps
org.apache.httpcomponents.core5:httpcore5from 5.2.5 to 5.3 - Bumps
org.apache.httpcomponents.client5:httpclient5from 5.3.1 to 5.4 - Bumps
io.github.classgraph:classgraphfrom 4.8.175 to 4.8.177
- Fix queries not preserving boost and name when converted to builders (#1181)
- Remove required check on ShardStats.shards (#1177)
- Fixed
TextEmbeddingProcessorreturning the wrong processor kind (#1127)
2.14.0 - 08/27/2024
- Added
queryImage(query_image) field toNeuralQuery, following definition in (Neural Query) (#1137) - Added
cancelAfterTimeIntervaltoSearchRequestandMsearchRequest(#1147) - Added the
mlnamespace operations (#1158) - Added
IndexTemplateMapping.Builder#withJson,SourceField.Builder#withJsonandIndexSettings.Builder#withJsonfor streamlining deserialization (#1148)
- Bumps
commons-logging:commons-loggingfrom 1.3.3 to 1.3.4 - Bumps
io.github.classgraph:classgraphfrom 4.8.174 to 4.8.175
- Fixed handling of NodeInfo fields that are not returned by Amazon OpenSearch Service (#1132)
2.13.0 - 08/01/2024
- Added
searchAfterValstoSearchRequestto allow passing arbitraryFieldValues tosearch_after(#1105)
- Changed URL path encoding to own implementation adapted from Apache HTTP Client 5's (#1109)
- Fixed error when deserializing a normalizer without 'type' (#1111)
- Fixed deserialization of SearchRequest when
_sourceis an array (#1117)
2.12.0 - 07/22/2024
- Added support for the
parentaggregation type (#706) - Added support for phase_took & search_pipeline request params (#1036)
- Added an interface PlainJsonSerializable with a default method for serialization to Json (#1064)
- Bumps
io.github.classgraph:classgraphfrom 4.8.173 to 4.8.174 - Bumps
org.owasp.dependencycheckfrom 9.1.0 to 10.0.2 - Bumps
com.github.jk1.dependency-license-reportfrom 2.7 to 2.8 - Bumps
commons-logging:commons-loggingfrom 1.3.2 to 1.3.3 - Bumps
org.apache.httpcomponents.core5:httpcore5-h2from 5.2.4 to 5.2.5 - Bumps
org.apache.httpcomponents.core5:httpcore5from 5.2.4 to 5.2.5
- Fixed deserializing of error responses when using AwsSdk2Transport (#1068)
2.11.1 - 06/27/2024
- Fixed handling of an absent
sourcein InlineGet (#1042)
2.11.0 - 06/20/2024
- Fixed error when deserializing an analyzer without
typespecified (#1033)
2.10.4 - 06/05/2024
- Added support for text embedding processor (#1007)
- ApacheHttpClient5Transport requires Apache Commons Logging dependency (#1003)
- Preserve caller information in stack traces when synchronous callers use asynchronous transports (#656)
- Fix java.lang.NoSuchMethodError: org.apache.http.client.utils.URLEncodedUtils.formatSegments w/o httpclient (#999)
2.10.3 - 05/16/2024
- Bumps
io.github.classgraph:classgraphfrom 4.8.170 to 4.8.172
- Fix the deserialization of SortOptions (#981)
- Generic HTTP Actions in Java Client does not work with AwsSdk2Transport (#978)
2.10.2 - 05/07/2024
- Fix integer overflow for variables in indices stats response (#960)
- Fix composite aggregations for search requests (#967)
2.10.1 - 04/16/2024
- Add missed fields to PhraseSuggestOption: collapseMatch (#940)
- Add missed fields to bulk's UpdateOperation: source (#947)
- Bumps
com.github.jk1.dependency-license-reportfrom 2.6 to 2.7
2.10.0 - 04/11/2024
- Add xy_shape property (#884)
- Add missed fields to MultisearchBody: seqNoPrimaryTerm, storedFields, explain, fields, indicesBoost (#914)
- Add OpenSearchGenericClient with support for raw HTTP request/responses (#910, #929)
- Add missed fields to MultisearchBody: collapse, version, timeout (#916
- Add missed fields to MultisearchBody: ext, rescore and to SearchRequest: ext (#918
- Bumps
io.github.classgraph:classgraphfrom 4.8.161 to 4.8.165 - Bumps
org.owasp.dependencycheckfrom 9.0.8 to 9.1.0 - Bumps
org.apache.httpcomponents.client5:httpclient5from 5.3.0 to 5.3.1 - Bumps
io.github.classgraph:classgraphfrom 4.8.165 to 4.8.170 - Bumps
jacksonfrom 2.15.2 to 2.17.0 - Bumps
org.eclipse.parsson:parssonfrom 1.1.5 to 1.1.6
- Delete shape property (#884)
- Fix integer overflow for variables in indices stats response (#877)
- Support weight function in function score query (#880)
- Fix pattern replace by making flag and replacement optional as on api (#895)
- Client with Java 8 runtime and Apache HttpClient 5 Transport fails with java.lang.NoSuchMethodError: java.nio.ByteBuffer.flip()Ljava/nio/ByteBuffer (#920)
- Add missed field "filter" to NeuralQuery model class
2.9.0 - 02/22/2024
- Add support for Hybrid query type (#850)
- Bumps org.ajoberstar.grgit:grgit-gradle from 5.2.0 to 5.2.2
- Fix missing properties on UpdateOperation (#744)
2.8.4 - 02/20/2024
- Add search role type for nodes in cluster stats (#848)
- Fix ClusterStatsResponse field deserialization (#848)
2.8.3 - 02/12/2024
- Fix PutTemplateRequest field deserialization (#723)
- Fix InnerHits to no longer enforce the nullable Index field when converting to Hit. (#838)
2.8.2 - 02/07/2024
- Added support for icu_collation_keyword type (#725)
- Added support for flat_object field property (#735)
- Expose HTTP status code through
ResponseException#status(#756) - Added toBuilder method to all request model in core package & _types.query_dsl package (#766)
- Added toQuery method in Query and QueryVariant (#760)
- Added missing WrapperQuery accessors and builder methods (#806)
- Bumps
com.diffplug.spotlessfrom 6.22.0 to 6.25.0 - Bumps
org.apache.httpcomponents.client5:httpclient5from 5.2.1 to 5.3 - Bumps
org.owasp.dependencycheckfrom 8.4.2 to 9.0.8
- Deprecated "_toQuery()" in Query and QueryVariant (#760)
- Removed unsupported
prefixfield from CompletionSuggester (#812)
- Fix partial success results for msearch_template (#709)
- Fix deserialization of node stats response (#745)
- Fix PutIndexTemplateRequest field deserialization (#765)
- Fix InnerHits to no longer enforce the nullable Index field when converting to Hit. (#825)
- Fix partial success results for msearch_template (#709)
2.8.0 - 01/11/2023
- Added support for indexing and search index settings (#667)
- Added support for neural query type (#674)
- Fixed Hit response when search request has storedFields as null (#698)
2.7.0 - 10/13/2023
- Added support for "smartcn" analyzer (#605)
- Added support for "cjk" analyzer (#604)
- Added support for wrapper queries (#630)
- Added support for "script_fields" in multi search request (#632)
- Added size attribute to MultiTermsAggregation (#627)
- Added version increment workflow that executes after release (#664)
- Bumps
org.ajoberstar.grgit:grgit-gradlefrom 5.0.0 to 5.2.0 - Bumps
com.github.jk1.dependency-license-reportfrom 2.4 to 2.5 - Bumps
io.github.classgraph:classgraphfrom 4.8.160 to 4.8.161
- Moved "software.amazon.awssdk" dependencies to the compileOnly scope. (#628)
- Migrated from checkstyle to spotless (#648)
- Remove generated code comments from all files (#598)
- Fix PutMappingRequest by removing unsupported fields (#597)
- [BUG] JarHell caused by latest software.amazon.awssdk 2.20.141 (#616)
- Don't over-allocate in HeapBufferedAsyncEntityConsumer in order to consume the response (#620)
- Fixed CVE-2976 + added CVE checker (#624)
- Fix parsing of GetFieldMappingResponse (#641)
- Fix TermvectorsResponse for optional fields (#642)
- Fix deserialization of MsearchTemplateResponse (#660)
2.6.0 - 07/05/2023
- Add support for knn_vector field type (#524)
- Add translog option object and missing translog sync interval option in index settings (#518)
- Adds the option to set slices=auto for UpdateByQueryRequest, DeleteByQueryRequest and ReindexRequest (#538)
- Add support for approximate k-NN queries (#548)
- Bumps
com.github.jk1.dependency-license-reportfrom 2.2 to 2.4 - Bumps
io.github.classgraph:classgraphfrom 4.8.157 to 4.8.160 - Bumps
jacksonfrom 2.14.2 to 2.15.2 ((#537)[opensearch-project#537]) - Update
org.apache.httpcomponents.client5:httpclient5from5.1.4to5.2.1andorg.apache.httpcomponents.core5:httpcore5from5.1.5to5.2.2
- Deprecate translogDurability and translogFlushThresholdSize in IndexSettings in favor of a separate translog object (#518)
- Fixed Suggesters for Completion, Term, and Phrase and refactored the Suggestion class (#477)
- Fix highlight max_analyzer_offset field name to match with the one introduced in OpenSearch 2.2.0 (#555)
2.5.0 - 06/02/2023
- Bumps
com.github.jk1.dependency-license-reportfrom 1.19 to 2.2 - Bumps
org.eclipse.parsson:parssonfrom 1.1.1 to 1.1.2
- Improve time taken by Github actions by using cache (#439)
- Introduce intermediary SearchResult for SearchResponse and SearchTemplateResponse classes, enabling similar response handling for both (#462)
- Fix missing Highlight and SourceConfig in the MultisearchBody (#442)
- Fix search failure with missing required property HitsMetadata.total when trackTotalHits is disabled (#372)
- Fix failure when deserialing response for tasks API (#463)
- Fix failure when deserializing boolean types for enums (#463)
- Fix missing minScore, postFilter, searchAfter, sort, trackScores in the MultisearchBody (#516)
2.4.0 - 04/11/2023
- Add buffered lookahead for Jackson (#338)
- Add support for headers and sort parameters in cat requests (#413)
- Add support for data stream operations (#419)
- Bumps
io.github.classgraph:classgraphfrom 4.8.156 to 4.8.157 (#408)
2.3.0 - 03/15/2023
- Prevent SPI calls at runtime (#293)
- Fix issue where completion suggestions were failing, due to being parsed as term suggestions (#350)
- Bulk UpdateOperation misses upsert options (#353)
- Fix missing key property in the RangeBucket (#381)
2.2.0 - 01/23/2023
- Add Github workflow for changelog verification (#239)
- Add Github workflow for dependabot PRs (#247)
- Add support for signing service name in AwsSdk2Transport (#324)
- Add new OpenSearchTransport based on Apache HttpClient 5 (#328)
- Add 1-click release workflows (#321)
- Add support for OpenSearch Serverless (#339)
- Add support to parse sub-aggregations from filter/nested aggregations (#234)
- Update literature around changelog contributions in CONTRIBUTING.md (#242)
- Update tests to use JUnit's Assert (#244)
- Add timeout and throttle to the jenkins workflows (#231)
- Update maintainers, admins and documentation (#248)
- Deprecate the totalDataSetSize and totalDataSetSizeInBytes fields in the StoreStats (#498)
- Remove support for unsupported dynamic_templates in bulk (#276)
- Make ChildrenAggregate as a SingleBucketAggregate (#306)
- Fix /_nodes/stats, /_nodes/info throwing serialization error (#315)
- Do not double-wrap OpenSearchException on error (#323)
- Fix AwsSdk2TransportOptions.responseCompression (#322)
- Fix missing Highlight and SourceConfig in the MultisearchBody (#442)
- Fix parsing /_alias error response for not existing alias (#476)
- Fix missing cause message in missing permission to call Fine Grained Access Control Amazon OpenSearch domain (#473)
- Fix catching JsonParsingException (#494)
- Fix StoryStats numeric value out of range of int (#489)