CHANGELOG.md

CHANGELOG

Inspired from Keep a Changelog

Unreleased 3.0

Dependencies

• Bumps org.eclipse.parsson:parsson from 1.1.6 to 1.1.7
• Bumps org.hamcrest:hamcrest from 2.2 to 3.0
• Bumps com.github.jk1.dependency-license-report from 2.8 to 2.9
• Bumps org.apache.httpcomponents.client5:httpclient5 from 5.4 to 5.4.1
• Bumps org.apache.httpcomponents.core5:httpcore5 from 5.3 to 5.3.1
• Bump org.junit:junit-bom from 5.11.3 to 5.11.4 (#1367)

This section is for maintaining a changelog for all breaking changes for the client that cannot be released in the 2.x line. All other non-breaking changes should be added to Unreleased 2.x section.

Added

• Document HTTP/2 support (#330)
• Added toBuilder() and Builder.copy() methods to all generated classes (#1300)

Dependencies

Changed

• 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's creationDateMillis field from String to long (#1124)
• Changed type of ShardStatistics's total, successful, failed & skipped fields from Number to int/Integer (#1158)
• Unified tasks.Info and tasks.State classes into tasks.TaskInfo (#1187)
• Changed type of Hit's sort field from List<String> to List<FieldValue> (#1225)
• Changed type of MultisearchBody's searchAfter field from List<String> to List<FieldValue> (#1225)

Deprecated

• Deprecate RestClientTransport (#536)

Removed

• Removed the features and shutdown namespaces as they're not supported by OpenSearch (#1361)
• Removed the indices.diskUsage operation as it's not supported by OpenSearch (#1361)

Fixed

• Fix version and build (#254)
• Fixed deserializing tasks.ListResponse when using GroupBy.None (#1187)

Security

Unreleased 2.x

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fixed serialization of time_zone field in CompositeDateHistogramAggregationSource (#1362)

Security

2.19.0 - 12/12/2024

Added

• Added support for IcuCollationKeywordProperty's country, language and variant properties (#1321)

Dependencies

• Bumps org.junit:junit-bom from 5.10.2 to 5.11.3
• Bump com.carrotsearch.randomizedtesting:randomizedtesting-runner from 2.8.1 to 2.8.2 (#1343)
• Bump org.owasp.dependencycheck from 11.1.0 to 11.1.1 (#1344)

Fixed

• 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 FieldSort was not implementing SortOptionsVariant (#1323)
• Fixed GetSnapshotResponse deserialization (#1299)
• Fixed CreateSnapshotResponse deserialization when wait_for_completion is false (#1332)
• Fixed serialization of nested aggregates under SingleBucketAggregateBase (#1350)

2.18.0 - 11/19/2024

Added

• Added support for disabling typed keys serialization (#1296)
• Added support for the batch_size param on the text_embedding processor (#1298)

Dependencies

• Bump io.github.classgraph:classgraph from 4.8.177 to 4.8.179 (#1302)

Changed

• 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

• Added support for KnnVectorProperty's compression_level, data_type, mode & space_type properties (#1255)

Dependencies

• Bumps org.apache.httpcomponents.core5:httpcore5-h2 from 5.3 to 5.3.1
• Bumps org.owasp.dependencycheck from 10.0.2 to 11.1.0

Fixed

• Fixed UndeployModelResponse deserialization (#1257)

2.16.0 - 10/22/2024

Added

• Added minScore and maxDistance to KnnQuery (#1166)
• Added minScore and maxDistance to NeuralQuery (#1235)

Dependencies

• Bumps org.ajoberstar.grgit:grgit-gradle from 5.2.2 to 5.3.0

Fixed

• Fixed deserializing GeoBoundsAggregate when bounds is not returned by OpenSearch (#1238)

2.15.0 - 10/17/2024

Added

• Added hashCode and equals implementations to generated code (#312)
• Added sortVals to Hit to allow retrieving non-string sort values (#1224)
• Added searchAfterVals to MultisearchBody to allow passing arbitrary FieldValues to search_after (#1224)

Dependencies

• Bumps org.junit:junit-bom from 5.10.3 to 5.11.1
• Bumps org.apache.httpcomponents.core5:httpcore5-h2 from 5.2.5 to 5.3
• Bumps org.apache.httpcomponents.core5:httpcore5 from 5.2.5 to 5.3
• Bumps org.apache.httpcomponents.client5:httpclient5 from 5.3.1 to 5.4
• Bumps io.github.classgraph:classgraph from 4.8.175 to 4.8.177

Fixed

• Fix queries not preserving boost and name when converted to builders (#1181)
• Remove required check on ShardStats.shards (#1177)
• Fixed TextEmbeddingProcessor returning the wrong processor kind (#1127)

2.14.0 - 08/27/2024

Added

• Added queryImage (query_image) field to NeuralQuery, following definition in (Neural Query) (#1137)
• Added cancelAfterTimeInterval to SearchRequest and MsearchRequest (#1147)
• Added the ml namespace operations (#1158)
• Added IndexTemplateMapping.Builder#withJson, SourceField.Builder#withJson and IndexSettings.Builder#withJson for streamlining deserialization (#1148)

Dependencies

• Bumps commons-logging:commons-logging from 1.3.3 to 1.3.4
• Bumps io.github.classgraph:classgraph from 4.8.174 to 4.8.175

Fixed

• Fixed handling of NodeInfo fields that are not returned by Amazon OpenSearch Service (#1132)

2.13.0 - 08/01/2024

Added

• Added searchAfterVals to SearchRequest to allow passing arbitrary FieldValues to search_after (#1105)

Changed

• Changed URL path encoding to own implementation adapted from Apache HTTP Client 5's (#1109)

Fixed

• Fixed error when deserializing a normalizer without 'type' (#1111)
• Fixed deserialization of SearchRequest when _source is an array (#1117)

2.12.0 - 07/22/2024

Added

• Added support for the parent aggregation 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)

Dependencies

• Bumps io.github.classgraph:classgraph from 4.8.173 to 4.8.174
• Bumps org.owasp.dependencycheck from 9.1.0 to 10.0.2
• Bumps com.github.jk1.dependency-license-report from 2.7 to 2.8
• Bumps commons-logging:commons-logging from 1.3.2 to 1.3.3
• Bumps org.apache.httpcomponents.core5:httpcore5-h2 from 5.2.4 to 5.2.5
• Bumps org.apache.httpcomponents.core5:httpcore5 from 5.2.4 to 5.2.5

Fixed

• Fixed deserializing of error responses when using AwsSdk2Transport (#1068)

2.11.1 - 06/27/2024

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fixed handling of an absent source in InlineGet (#1042)

Security

2.11.0 - 06/20/2024

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fixed error when deserializing an analyzer without type specified (#1033)

Security

2.10.4 - 06/05/2024

Added

• Added support for text embedding processor (#1007)

Dependencies

Changed

Deprecated

Removed

Fixed

• 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)

Security

2.10.3 - 05/16/2024

Added

Dependencies

• Bumps io.github.classgraph:classgraph from 4.8.170 to 4.8.172

Changed

Deprecated

Removed

Fixed

• Fix the deserialization of SortOptions (#981)
• Generic HTTP Actions in Java Client does not work with AwsSdk2Transport (#978)

Security

2.10.2 - 05/07/2024

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fix integer overflow for variables in indices stats response (#960)
• Fix composite aggregations for search requests (#967)

Security

2.10.1 - 04/16/2024

Added

• Add missed fields to PhraseSuggestOption: collapseMatch (#940)
• Add missed fields to bulk's UpdateOperation: source (#947)

Dependencies

• Bumps com.github.jk1.dependency-license-report from 2.6 to 2.7

Changed

Deprecated

Removed

Fixed

Security

2.10.0 - 04/11/2024

Added

• 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

Dependencies

• Bumps io.github.classgraph:classgraph from 4.8.161 to 4.8.165
• Bumps org.owasp.dependencycheck from 9.0.8 to 9.1.0
• Bumps org.apache.httpcomponents.client5:httpclient5 from 5.3.0 to 5.3.1
• Bumps io.github.classgraph:classgraph from 4.8.165 to 4.8.170
• Bumps jackson from 2.15.2 to 2.17.0
• Bumps org.eclipse.parsson:parsson from 1.1.5 to 1.1.6

Changed

Deprecated

Removed

• Delete shape property (#884)

Fixed

• 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

Security

2.9.0 - 02/22/2024

Added

• Add support for Hybrid query type (#850)

Dependencies

• Bumps org.ajoberstar.grgit:grgit-gradle from 5.2.0 to 5.2.2

Changed

• Restore support for Java 8 (#767)
• Add an integration test that runs on JDK-8 (#795)

Deprecated

Removed

Fixed

• Fix missing properties on UpdateOperation (#744)

Security

2.8.4 - 02/20/2024

Added

• Add search role type for nodes in cluster stats (#848)

Dependencies

Changed

Deprecated

Removed

Fixed

• Fix ClusterStatsResponse field deserialization (#848)

Security

2.8.3 - 02/12/2024

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fix PutTemplateRequest field deserialization (#723)
• Fix InnerHits to no longer enforce the nullable Index field when converting to Hit. (#838)

Security

2.8.2 - 02/07/2024

Added

• 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)

Dependencies

• Bumps com.diffplug.spotless from 6.22.0 to 6.25.0
• Bumps org.apache.httpcomponents.client5:httpclient5 from 5.2.1 to 5.3
• Bumps org.owasp.dependencycheck from 8.4.2 to 9.0.8

Changed

Deprecated

• Deprecated "_toQuery()" in Query and QueryVariant (#760)

Removed

• Removed unsupported prefix field from CompletionSuggester (#812)

Fixed

• 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)

Security

2.8.1

Added

Dependencies

Changed

Deprecated

Removed

Fixed

• Fix partial success results for msearch_template (#709)

Security

2.8.0 - 01/11/2023

Added

• Added support for indexing and search index settings (#667)
• Added support for neural query type (#674)

Dependencies

Changed

• Allow null values in arrays (#687)
• Add an example for bulk update operation in samples (#690)

Deprecated

Removed

Fixed

• Fixed Hit response when search request has storedFields as null (#698)

Security

2.7.0 - 10/13/2023

Added

• 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)

Dependencies

• Bumps org.ajoberstar.grgit:grgit-gradle from 5.0.0 to 5.2.0
• Bumps com.github.jk1.dependency-license-report from 2.4 to 2.5
• Bumps io.github.classgraph:classgraph from 4.8.160 to 4.8.161

Changed

• Moved "software.amazon.awssdk" dependencies to the compileOnly scope. (#628)
• Migrated from checkstyle to spotless (#648)

Deprecated

Removed

• Remove generated code comments from all files (#598)

Fixed

• 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)

Security

2.6.0 - 07/05/2023

Added

• 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)

Dependencies

• Bumps com.github.jk1.dependency-license-report from 2.2 to 2.4
• Bumps io.github.classgraph:classgraph from 4.8.157 to 4.8.160
• Bumps jackson from 2.14.2 to 2.15.2 ((#537)[#537])
• Update org.apache.httpcomponents.client5:httpclient5 from 5.1.4 to 5.2.1 and org.apache.httpcomponents.core5:httpcore5 from 5.1.5 to 5.2.2

Changed

Deprecated

• Deprecate translogDurability and translogFlushThresholdSize in IndexSettings in favor of a separate translog object (#518)

Removed

Fixed

• 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)

Security

2.5.0 - 06/02/2023

Added

• Add workflow to publish snapshots via GHA (#454)
• Added Point-In-Time APIs (#461)

Dependencies

• Bumps com.github.jk1.dependency-license-report from 1.19 to 2.2
• Bumps org.eclipse.parsson:parsson from 1.1.1 to 1.1.2

Changed

• 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)

Deprecated

Removed

Fixed

• 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)

Security

2.4.0 - 04/11/2023

Added

• Add buffered lookahead for Jackson (#338)
• Add support for headers and sort parameters in cat requests (#413)
• Add support for data stream operations (#419)

Dependencies

• Bumps io.github.classgraph:classgraph from 4.8.156 to 4.8.157 (#408)

Changed

Deprecated

Removed

Fixed

Security

2.3.0 - 03/15/2023

Added

• Require two maintainers to approve release (#383)
• Add support for mapping limit settings (#382)

Dependencies

• Bumps Jackson from 2.14.1 to 2.14.2 (#357)
• Bumps classgraph from 4.8.149 to 4.8.156 (#395)

Changed

• Prevent SPI calls at runtime (#293)

Deprecated

Removed

Fixed

• 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)

Security

2.2.0 - 01/23/2023

Added

• 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)

Dependencies

• Bumps grgit-gradle from 4.0.1 to 5.0.0
• Update Jackson to 2.14.0 (#259)
• Update Gradle to 7.6 (#311)

Changed

• 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)

Deprecated

• Deprecate the totalDataSetSize and totalDataSetSizeInBytes fields in the StoreStats (#498)

Removed

• Remove support for unsupported dynamic_templates in bulk (#276)

Fixed

• 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)

Security