Skip to content

Add x-protobuf-name vendor extension and add index parameters to search and bulk API#993

Merged
lucy66hw merged 4 commits intoopensearch-project:mainfrom
lucy66hw:x-protobuf-excluded-2
Nov 20, 2025
Merged

Add x-protobuf-name vendor extension and add index parameters to search and bulk API#993
lucy66hw merged 4 commits intoopensearch-project:mainfrom
lucy66hw:x-protobuf-excluded-2

Conversation

@lucy66hw
Copy link
Copy Markdown
Collaborator

@lucy66hw lucy66hw commented Nov 19, 2025 •
edited
Loading

Description

  1. Add x-protobuf-name vendor extension for protobuf convert.
  2. Add index parameters to search and bulk API . https://github.com/opensearch-project/OpenSearch/blob/main/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java#L192

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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 Nov 19, 2025 •
edited
Loading

Changes Analysis

Commit SHA: 081ec36
Comparing To SHA: e51480a

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_search
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] style (28138:14)
│ │ │ │ ├──[🔀] in (28130:11)❌ 
│ │ │ │ └──[➖] required (27928:17)
│ │ │ └─┬Parameters
│ │ │   └─┬Extensions
│ │ │     └──[➕] x-protobuf-name (28224:24)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ ├──[🔀] style (28138:14)
│ │   │ ├──[🔀] in (28130:11)❌ 
│ │   │ └──[➖] required (27928:17)
│ │   └─┬Parameters
│ │     └─┬Extensions
│ │       └──[➕] x-protobuf-name (28224:24)
│ ├─┬/_search
│ │ ├─┬GET
│ │ │ ├──[➕] parameters (28131:13)
│ │ │ └─┬Parameters
│ │ │   └─┬Extensions
│ │ │     └──[➕] x-protobuf-name (28224:24)
│ │ └─┬POST
│ │   ├──[➕] parameters (28131:13)
│ │   └─┬Parameters
│ │     └─┬Extensions
│ │       └──[➕] x-protobuf-name (28224:24)
│ ├─┬/_bulk
│ │ ├─┬PUT
│ │ │ └──[➕] parameters (17881:13)
│ │ └─┬POST
│ │   └──[➕] parameters (17881:13)
│ ├─┬/{index}/_termvectors
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (29683:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (29683:20)
│ ├─┬/{index}/_bulk
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] style (17885:14)
│ │ │   ├──[🔀] in (17880:11)❌ 
│ │ │   └──[➖] required (17845:17)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     ├──[🔀] style (17885:14)
│ │     ├──[🔀] in (17880:11)❌ 
│ │     └──[➖] required (17845:17)
│ ├─┬/{index}/_mtermvectors
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (26494:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (26494:20)
│ ├─┬/_mtermvectors
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (26494:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (26494:20)
│ └─┬/{index}/_termvectors/{id}
│   ├─┬GET
│   │ └─┬Parameters
│   │   └──[🔀] description (29683:20)
│   └─┬POST
│     └─┬Parameters
│       └──[🔀] description (29683:20)
└─┬Components
  ├──[➕] parameters (28130:7)
  ├──[➕] parameters (17880:7)
  ├──[➖] schemas (49551:7)❌ 
  ├──[➕] schemas (49580:7)
  └─┬_common___ShardFailure
    └──[➕] required (40136:11)❌
Document Element Total Changes Breaking Changes
components 5 2
paths 28 4
  • ❌ BREAKING Changes: 6 out of 33
  • Modifications: 16
  • Removals: 5
  • Additions: 12
  • Breaking Removals: 1
  • Breaking Modifications: 4
  • Breaking Additions: 1

Report

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

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 19, 2025

Spec Test Coverage Analysis

Total Tested
682 680 (99.71 %)

@lucy66hw
Add x-protobuf-name vendor extension and add index parameters to sear…
742eb58 
…ch and bulk API

Signed-off-by: xil <fridalu66@gmail.com>
@lucy66hw lucy66hw force-pushed the x-protobuf-excluded-2 branch from 4a76d50 to 742eb58 Compare November 19, 2025 23:51
@lucy66hw
update changelog
302a5d3 
Signed-off-by: xil <fridalu66@gmail.com>
@lucy66hw
fix lint error
19a45c9 
Signed-off-by: xil <fridalu66@gmail.com>
@lucy66hw lucy66hw changed the title Add x-protobuf-name vendor extension Add x-protobuf-name vendor extension and add index parameters to search and bulk API Nov 20, 2025
@lucy66hw
update
081ec36 
Signed-off-by: xil <fridalu66@gmail.com>
@lucy66hw lucy66hw force-pushed the x-protobuf-excluded-2 branch from 8c8a4e7 to 081ec36 Compare November 20, 2025 04:17
@lucy66hw lucy66hw marked this pull request as ready for review November 20, 2025 04:56
@lucy66hw lucy66hw merged commit 71bc4ac into opensearch-project:main Nov 20, 2025
42 checks passed
zzfrankz pushed a commit to zzfrankz/opensearch-api-specification that referenced this pull request Nov 25, 2025
@lucy66hw @zzfrankz
Add x-protobuf-name vendor extension and add index parameters to sear…
e65cff3 
…ch and bulk API (opensearch-project#993)

* Add x-protobuf-name vendor extension and add index parameters to search and bulk API

Signed-off-by: xil <fridalu66@gmail.com>

---------

Signed-off-by: xil <fridalu66@gmail.com>
Signed-off-by: Frank Zhang <zz.frankz@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@karenyrx karenyrx karenyrx 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

@lucy66hw @karenyrx