Skip to content

Add missing ShardSearchFailure#1040

Merged
karenyrx merged 2 commits intoopensearch-project:mainfrom
karenyrx:shardfailures
Feb 17, 2026
Merged

Add missing ShardSearchFailure#1040
karenyrx merged 2 commits intoopensearch-project:mainfrom
karenyrx:shardfailures

Conversation

@karenyrx
Copy link
Collaborator

@karenyrx karenyrx commented Feb 16, 2026

Description

This fix resolves the issue where the OpenSearch Java client was failing with MissingRequiredPropertyException when deserializing search responses. The spec now correctly distinguishes between:

  • Search failures (ShardSearchFailure) - no primary field in server code
  • Bulk/write failures (ShardFailure) - has required primary field in server code

Issues Resolved

opensearch-project/opensearch-java#1877

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 16, 2026

Changes Analysis

Commit SHA: 8ec483d
Comparing To SHA: 5c4f7ed

API Changes

Summary

└─┬Components
  └──[➕] schemas/_common___ShardSearchFailure (40856:7)

Document Element Total Changes Breaking Changes
components 1 0
  • Total Changes: 1
  • Additions: 1

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/22080860453/artifacts/5532103810

API Coverage

Before After Δ
Covered (%) 666 (65.23 %) 666 (65.23 %) 0 (0 %)
Uncovered (%) 355 (34.77 %) 355 (34.77 %) 0 (0 %)
Unknown 149 149 0

Signed-off-by: Karen X <karenxyr@gmail.com>
@karenyrx
Copy link
Collaborator Author

Proto compatibility check awaiting fix in opensearch-project/opensearch-protobufs#388 before being rerun

@github-actions
Copy link
Contributor

github-actions bot commented Feb 16, 2026

Proto Compatibility Report

Merge Report

Message Changes

Message Change Field
ShardStatistics 🗑️ DEPRECATED repeated ShardFailure failures = 4 [deprecated = true]
ShardStatistics ADDED repeated ShardSearchFailure failures_2 = 6

Legend

  • 🗑️ DEPRECATED - Field/value annotated as deprecated in protobufs and will be officially removed in the next major OpenSearch release
  • ADDED - New field/value added at the end of the message/enum
  • ✏️ RENAMED - Field renamed in-place
  • 🚨 BREAKING - This change will cause breaking change to Protobuf

Generated by Proto Compatibility Check

Signed-off-by: Karen X <karenxyr@gmail.com>
@karenyrx
Copy link
Collaborator Author

karenyrx commented Feb 16, 2026

The failing CI is not related to this PR, as it is also failing on main branch: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/22080607191/job/63804886957

Will debug separately

@karenyrx karenyrx marked this pull request as ready for review February 16, 2026 23:50
@karenyrx karenyrx merged commit cbb07cd into opensearch-project:main Feb 17, 2026
42 of 43 checks passed
@janhoy
Copy link

janhoy commented Feb 17, 2026

Question @karenyrx . The CHANGELOG entry for this change was added under the section ## [0.2.0] - 2025-05-25. Looks wrong, as that was released in may last year? What will be the next version of the API-spec, and what version will v3.7.0 of opensearch-java use, vs what version will v4.0.0 eventually use? Do we need any backport somewhere to make sure this lands in 3.7.0?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants