Fix ShardFailure.shard incorrectly required causing MissingRequiredPropertyException - #2037
Open
gingeekrishna wants to merge 3 commits into
Open
Conversation
gingeekrishna
requested review from
Bukhtawar,
VachaShah,
Xtansia,
madhusudhankonda,
saratvemulapalli and
szczepanczykd
as code owners
July 5, 2026 07:36
gingeekrishna
added a commit
to gingeekrishna/opensearch-java
that referenced
this pull request
Jul 5, 2026
Signed-off-by: Radhakrishnan Pachyappan <gingeekrishna@gmail.com>
…rsing_exception The _common___DerivedField schema in opensearch-openapi.yaml included a required name property. This caused DerivedField.java to serialize a name key into the JSON mapping body, but the OpenSearch API does not accept name inside a derived field definition and returns: mapper_parsing_exception: unknown parameter [name] on mapper In the API, the derived field's name is expressed as the map key in the parent derived object, not as a property inside the field definition. Remove name from the _common___DerivedField schema (both from properties and required) and update the generated DerivedField.java accordingly. The Java client no longer serializes name inside derived field definitions. Fixes opensearch-project#1937 Signed-off-by: Radhakrishnan Pachyappan <gingeekrishna@gmail.com>
…ailure ShardFailure.shard was marked as required in the spec, so the generated class threw MissingRequiredPropertyException when OpenSearch returned a ShardFailure without the shard field — masking the real failure. Per the OpenSearch API, shard is an optional integer in ShardFailure (the primary failure reason is always present; the shard number may be absent for certain failure types). Remove shard from the required list in _common___ShardFailure and update the generated ShardFailure.java to use @nullable Integer with proper null guards in serialization, hashCode, and equals. Fixes opensearch-project#1799 Signed-off-by: Radhakrishnan Pachyappan <gingeekrishna@gmail.com>
Signed-off-by: Radhakrishnan Pachyappan <gingeekrishna@gmail.com>
gingeekrishna
force-pushed
the
fix/1799-shardfailure-shard-nullable
branch
from
August 16, 2026 16:10
2dfacc8 to
a80639b
Compare
reta
reviewed
Aug 16, 2026
Collaborator
There was a problem hiding this comment.
Please submit a change against https://github.com/opensearch-project/openSearch-api-specification, thank you
Author
There was a problem hiding this comment.
Submitted the spec fix upstream: opensearch-project/opensearch-api-specification#1194
reta
requested changes
Aug 16, 2026
Open
2 tasks
Author
|
Submitted the spec fix upstream: opensearch-project/opensearch-api-specification#1194 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1799
Problem: When OpenSearch returns a
ShardFailurewithout ashardfield (which can happen for certain failure types), the Java client throwsMissingRequiredPropertyException: Missing required property 'ShardFailure.shard'— masking the real failure that the caller was trying to handle.Root cause:
_common___ShardFailureinopensearch-openapi.yamllistedshardinrequired. The generatedShardFailure.javausedApiTypeHelper.requireNonNull(builder.shard, ...)which throws when the field is absent in the JSON response.According to the OpenSearch API,
shardis an optional integer — the required fields in a shard failure areprimary(bool) andreason(ErrorCause). The shard number may legitimately be absent for certain failure scenarios.Fix: Remove
shardfromrequiredin the spec and update the generatedShardFailure.java:int→@Nullable IntegerrequireNonNull→ direct assignment@Nullable IntegerhashCode/equals: useObjects.hashCode/Objects.equalsChanges
java-codegen/opensearch-openapi.yaml— removeshardfrom_common___ShardFailure.requiredjava-client/src/generated/java/org/opensearch/client/opensearch/_types/ShardFailure.java— makeshardnullable throughout