Skip to content

Add static method to expose STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED index option#20980

Merged
cwperks merged 1 commit into
opensearch-project:mainfrom
lukas-vlcek:20963
Mar 24, 2026
Merged

Add static method to expose STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED index option#20980
cwperks merged 1 commit into
opensearch-project:mainfrom
lukas-vlcek:20963

Conversation

@lukas-vlcek
Copy link
Copy Markdown
Contributor

@lukas-vlcek lukas-vlcek commented Mar 24, 2026

Description

IndicesOptions class provide static methods to access all index options but this one. It seems like it has been forgotten. This PR addresses this which makes it possible to document this option the same way other index options are documented.

Important question: Does this PR changes public API in any way that needs to be documented or annotated?

I also changed one test to use access method instead of directly access the constant instance. See #20981 for more general discussion about this.

Related Issues

Closes: #20963

Check List

  • Functionality includes testing.
  • API changes companion pull request created, if applicable.
  • Public documentation issue/PR created, if applicable.

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.

@lukas-vlcek lukas-vlcek requested a review from a team as a code owner March 24, 2026 09:00
@github-actions github-actions Bot added bug Something isn't working Other labels Mar 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 24, 2026

PR Reviewer Guide 🔍

(Review updated until commit 52e8bad)

Here are some key observations to aid the review process:

🧪 No relevant tests
🔒 No security concerns identified
📝 TODO sections

🔀 No multiple PR themes
⚡ No major issues detected

@lukas-vlcek
Copy link
Copy Markdown
Contributor Author

To admins: I am not sure about the bug label for this PR. Should it be labeled as an enhancement instead (if there is such a label)?

@github-actions
Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0cad5ac

@github-actions
Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix missing blank line in changelog

The new changelog entry is missing a blank line before the ### Changed section
header. According to the existing format in the file, there should be an empty line
separating entries from section headers to maintain consistent formatting.

CHANGELOG.md [29-30]

 - Add a new static method to IndicesOptions API to expose `STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED` index option ([#20980](https://github.com/opensearch-project/OpenSearch/pull/20980))
+
 ### Changed
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies that a blank line is missing between the new changelog entry and the ### Changed section header, which would improve formatting consistency. However, this is a minor formatting issue with low impact on functionality.

Low

…ndex option

IndicesOptions class provide static methods to access all index options but this one.
It seems like it has been forgotten. This PR addresses this which makes it possible
to document this option the same way other index options are documented.

Closes: opensearch-project#20963

Signed-off-by: Lukáš Vlček <lukas.vlcek@gmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 52e8bad

@lukas-vlcek
Copy link
Copy Markdown
Contributor Author

‎CHANGELOG.md is a bit messed up at this point. I am adding an extra empty line after my new entry but notice that there is already one extra empty line in the list of enhancements. I do not want to put my record into that extra empty line because I think that waould make merging more conflicting for others.

@github-actions
Copy link
Copy Markdown
Contributor

✅ Gradle check result for 52e8bad: SUCCESS

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.26%. Comparing base (6082a2a) to head (52e8bad).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #20980      +/-   ##
============================================
- Coverage     73.28%   73.26%   -0.03%     
- Complexity    72490    72509      +19     
============================================
  Files          5819     5819              
  Lines        331398   331399       +1     
  Branches      47887    47887              
============================================
- Hits         242875   242794      -81     
- Misses        68984    69073      +89     
+ Partials      19539    19532       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cwperks cwperks changed the title Add static method to expose STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED i… Add static method to expose STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED index option Mar 24, 2026
@cwperks
Copy link
Copy Markdown
Member

cwperks commented Mar 24, 2026

To admins: I am not sure about the bug label for this PR. Should it be labeled as an enhancement instead (if there is such a label)?

IMO Changed would be the most appropriate category for this.

@cwperks cwperks merged commit e9e7601 into opensearch-project:main Mar 24, 2026
38 checks passed
@cwperks cwperks added the v3.6.0 Issues and PRs related to version 3.6.0 label Mar 24, 2026
@lukas-vlcek lukas-vlcek deleted the 20963 branch March 24, 2026 12:23
gagandhakrey pushed a commit to gagandhakrey/OpenSearch that referenced this pull request Apr 1, 2026
…ndex option (opensearch-project#20980)

IndicesOptions class provide static methods to access all index options but this one.
It seems like it has been forgotten. This PR addresses this which makes it possible
to document this option the same way other index options are documented.

Closes: opensearch-project#20963

Signed-off-by: Lukáš Vlček <lukas.vlcek@gmail.com>
Signed-off-by: Gagan Dhakrey <gagandhakrey@Gagans-MacBook-Pro.local>
aparajita31pandey pushed a commit to aparajita31pandey/OpenSearch that referenced this pull request Apr 18, 2026
…ndex option (opensearch-project#20980)

IndicesOptions class provide static methods to access all index options but this one.
It seems like it has been forgotten. This PR addresses this which makes it possible
to document this option the same way other index options are documented.

Closes: opensearch-project#20963

Signed-off-by: Lukáš Vlček <lukas.vlcek@gmail.com>
Signed-off-by: Aparajita Pandey <aparajita31pandey@gmail.com>
pradeep-L pushed a commit to pradeep-L/OpenSearch that referenced this pull request Apr 21, 2026
…ndex option (opensearch-project#20980)

IndicesOptions class provide static methods to access all index options but this one.
It seems like it has been forgotten. This PR addresses this which makes it possible
to document this option the same way other index options are documented.

Closes: opensearch-project#20963

Signed-off-by: Lukáš Vlček <lukas.vlcek@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working Other v3.6.0 Issues and PRs related to version 3.6.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Missing static method exposing STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED index option

2 participants