Skip to content

Update TermsAggregation, CardinalityExecutionMode fields #982

Merged
karenyrx merged 3 commits intoopensearch-project:mainfrom
karenyrx:aggregations
Dec 3, 2025
Merged

Update TermsAggregation, CardinalityExecutionMode fields #982
karenyrx merged 3 commits intoopensearch-project:mainfrom
karenyrx:aggregations

Conversation

@karenyrx
Copy link
Copy Markdown
Collaborator

@karenyrx karenyrx commented Oct 30, 2025 •
edited
Loading

Description

1. TermsAggregation: Removed unsupported fields

Removed missing_order and missing_bucket fields from TermsAggregation as they are not supported by TermsAggregationBuilder.

  • Evidence: TermsAggregationBuilder.PARSER (lines 119-159) does not parse missing_order or missing_bucket fields
  • Evidence: TermsAggregationBuilder.doXContentBody() (lines 353-404) does not serialize these fields
  • These fields belong to CompositeAggregation and were incorrectly included in the TermsAggregation spec

Source references:

2. TermsAggregation: Added missing shard_min_doc_count field

Added the shard_min_doc_count field which is supported by TermsAggregationBuilder.PARSER but was missing from the spec

3. CardinalityExecutionMode: Added segment_ordinals enum value

Added segment_ordinals execution hint option introduced in OpenSearch 2.19.1 via PR #17312.

Source references:

Issues Resolved

Part of opensearch-project/opensearch-protobufs#30

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
Copy Markdown
Contributor

github-actions Bot commented Oct 30, 2025 •
edited
Loading

Changes Analysis

Commit SHA: 1e400ea
Comparing To SHA: 8978c52

API Changes

Summary

└─┬Components
  ├─┬_common.aggregations___TermsAggregation
  │ └─┬ALLOF
  │   ├──[➖] properties (43893:13)❌ 
  │   ├──[➖] properties (43891:13)❌ 
  │   └──[➕] properties (43905:13)
  └─┬_common.aggregations___CardinalityExecutionMode
    └──[➕] enum (41648:11)
Document Element Total Changes Breaking Changes
components 4 4
  • ❌ BREAKING Changes: 4 out of 4
  • Removals: 2
  • Additions: 2
  • Breaking Removals: 2

Report

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

API Coverage

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

@karenyrx
Update aggregations
52bca8c 
Signed-off-by: Karen X <karenxyr@gmail.com>
@karenyrx karenyrx changed the title Update aggregations Update TermsAggregation, CardinalityExecutionMode protos Oct 30, 2025
@karenyrx karenyrx changed the title Update TermsAggregation, CardinalityExecutionMode protos Update TermsAggregation, CardinalityExecutionMode protos Oct 30, 2025
@karenyrx
changelog
a8dadb3 
Signed-off-by: Karen X <karenxyr@gmail.com>
@karenyrx karenyrx changed the title Update TermsAggregation, CardinalityExecutionMode protos Update TermsAggregation, CardinalityExecutionMode fields Oct 30, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 30, 2025

Spec Test Coverage Analysis

Total Tested
682 680 (99.71 %)

@karenyrx karenyrx marked this pull request as ready for review October 30, 2025 04:05
@lucy66hw
Merge branch 'main' into aggregations
1e400ea 
Signed-off-by: Xi Lu <fridalu66@gmail.com>
@karenyrx karenyrx merged commit 6a051ee into opensearch-project:main Dec 3, 2025
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucy66hw lucy66hw lucy66hw approved these changes

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@Xtansia Xtansia Awaiting requested review from Xtansia Xtansia is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@Tokesh Tokesh Awaiting requested review from Tokesh Tokesh is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@karenyrx @lucy66hw