Skip to content

docs: Add ref_path parameter documentation for hunspell token filter#12161

Merged
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
shayush622:docs/hunspell-ref-path
Mar 30, 2026
Merged

docs: Add ref_path parameter documentation for hunspell token filter#12161
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
shayush622:docs/hunspell-ref-path

Conversation

@shayush622
Copy link
Copy Markdown
Contributor

  • Document new ref_path parameter for package-based dictionary loading
  • Add package-based dictionary loading section with directory structure and examples
  • Add multi-tenant usage examples (medical-dict, legal-dict)
  • Document fallback behavior when ref_path is not specified
  • Add validation constraints for ref_path and locale values

Description

Customer(s) can now use package based dictionary i.e. it provides support for multiple same locale support which might contain different affix rules, across different packages.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copilot AI review requested due to automatic review settings March 27, 2026 20:00
@github-actions
Copy link
Copy Markdown

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).

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents the new ref_path parameter for the Hunspell token filter to support package-based dictionary loading, enabling multiple dictionary sets for the same locale.

Changes:

  • Document ref_path parameter and default fallback behavior when it’s not specified.
  • Add a new “Package-based dictionary loading” section with directory layout and JSON examples for multi-tenant dictionary usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Document new ref_path parameter for package-based dictionary loading
- Add package-based dictionary loading section with directory structure and examples
- Add multi-tenant usage examples (medical-dict, legal-dict)
- Document fallback behavior when ref_path is not specified
- Add validation constraints for ref_path and locale values

Signed-off-by: Ayush Sharma <118544643+shayush622@users.noreply.github.com>
Signed-off-by: ayushify <ayushify@amazon.com>
Signed-off-by: shayush622 <ayush5267@gmail.com>
@shayush622 shayush622 force-pushed the docs/hunspell-ref-path branch from 0a6a093 to 0194fc6 Compare March 29, 2026 12:01
@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.6.0 labels Mar 30, 2026
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Copy Markdown
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @shayush622! LGTM

@kolchfa-aws kolchfa-aws merged commit 46cfd0f into opensearch-project:main Mar 30, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.6.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants