Document plugins.security.restapi.max_string_length setting - #12989
Open
DarshitChanpura wants to merge 1 commit into
Open
Document plugins.security.restapi.max_string_length setting#12989DarshitChanpura wants to merge 1 commit into
DarshitChanpura wants to merge 1 commit into
Conversation
Adds documentation for the new configurable REST API request body string length limit (default 4096) introduced in opensearch-project/security#6437, which supersedes the previously hard-coded 256-character limit. Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
DarshitChanpura
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
August 28, 2026 03:23
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
kolchfa-aws
added
release-notes
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
2 participants
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
Documents the new
plugins.security.restapi.max_string_lengthsetting, which makes the Security plugin's REST API request body string-length limit configurable (default4096).Background: opensearch-security 3.8.0.0 introduced a hard-coded 256-character limit on every string value in a Security REST API request body, which broke legitimate configurations with large free-form values such as document-level security (DLS) queries (opensearch-project/security#6434). The code change replaces that hard limit with this configurable setting (opensearch-project/security#6437).
Added under
_security/configuration/yaml.md→ opensearch.yml as a new "REST API request body validation" subsection, next to the existing REST API password settings.Issues Resolved
Documentation follow-up for opensearch-project/security#6434 / opensearch-project/security#6437.
Version
Targets the release that ships opensearch-project/security#6437 (3.9.0, with a planned backport to a 3.8 patch). Maintainers: please advise if this should be labeled for a specific version branch.
Checklist
For any changes to documentation, I have reviewed the OpenSearch Project style guidelines.