Document Hunspell hot-reload and ref_path refactor for 3.7#12486
Merged
kolchfa-aws merged 4 commits intoJun 3, 2026
Conversation
Update the Hunspell token filter docs to reflect the hot-reload support and ref_path path-resolution change landing in OpenSearch 3.7 (opensearch-project/OpenSearch#21516, #21559 and opensearch-project/index-management#1638): - Add the new `updateable` filter parameter. - Update `ref_path` to resolve under `<OS_PATH_CONF>` directly (was `<OS_PATH_CONF>/analyzers/`) and allow forward slashes for nested paths; add an upgrade note for users coming from 3.6. - Rename "Package-based dictionary loading" to "Custom dictionary loading with ref_path" and refresh examples to use the new layout. - Add a "Hot-reloading Hunspell dictionaries" section covering the `updateable` + `_refresh_search_analyzers?reload_cached_resources=true` workflow. - Document the new `reload_cached_resources` query parameter on the Refresh search analyzer API page. Signed-off-by: shayush622 <ayush5267@gmail.com>
shayush622
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
|
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). |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates OpenSearch documentation to describe new/changed analyzer refresh behavior and Hunspell dictionary loading/reloading options.
Changes:
- Documented
reload_cached_resourcesquery parameter for the Refresh search analyzer API. - Updated Hunspell
ref_pathsemantics and examples to reflect the 3.7 path resolution change. - Added Hunspell hot-reload documentation via
updateable+ Refresh search analyzer API.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| _im-plugin/refresh-analyzer.md | Adds query parameter documentation for controlling cached resource reload behavior. |
| _analyzers/token-filters/hunspell.md | Updates ref_path behavior/docs and adds hot-reload guidance and new updateable parameter documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Parameter | Data type | Description | ||
| :--- | :--- | :--- | ||
| `reload_cached_resources` | Boolean | When set to `true`, in-place reloads cached resources for token filters that load files from disk (for example, the [`hunspell`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/hunspell/) filter's dictionary files). When `false` (the default), analyzer factories are rebuilt but cached resources are reused. **Introduced 3.7.** |
kolchfa-aws
added
Doc review
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
reviewed
Jun 3, 2026
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
kolchfa-aws
approved these changes
Jun 3, 2026
kolchfa-aws
left a comment
kolchfa-aws
left a comment
Collaborator
There was a problem hiding this comment.
Thank you, @shayush622! Doc review complete and changes applied. LGTM.
kolchfa-aws
reviewed
Jun 3, 2026
kolchfa-aws
reviewed
Jun 3, 2026
kolchfa-aws
reviewed
Jun 3, 2026
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Contributor
Author
|
Thank you, @kolchfa-aws for the review :) |
aryasoni98
pushed a commit
to aryasoni98/documentation-website
that referenced
this pull request
Jun 29, 2026
…h-project#12486) * Document Hunspell hot-reload and ref_path refactor for 3.7 Update the Hunspell token filter docs to reflect the hot-reload support and ref_path path-resolution change landing in OpenSearch 3.7 (opensearch-project/OpenSearch#21516, #21559 and opensearch-project/index-management#1638): - Add the new `updateable` filter parameter. - Update `ref_path` to resolve under `<OS_PATH_CONF>` directly (was `<OS_PATH_CONF>/analyzers/`) and allow forward slashes for nested paths; add an upgrade note for users coming from 3.6. - Rename "Package-based dictionary loading" to "Custom dictionary loading with ref_path" and refresh examples to use the new layout. - Add a "Hot-reloading Hunspell dictionaries" section covering the `updateable` + `_refresh_search_analyzers?reload_cached_resources=true` workflow. - Document the new `reload_cached_resources` query parameter on the Refresh search analyzer API page. Signed-off-by: shayush622 <ayush5267@gmail.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestion from @kolchfa-aws Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: shayush622 <ayush5267@gmail.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Arya Soni <aryasoni98@gmail.com>
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
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
Updates the Hunspell token filter documentation to reflect three changes
landing in OpenSearch 3.7:
ref_pathpath-resolution refactor (opensearch-project/OpenSearch#21516) —ref_pathnow resolves directly under<OS_PATH_CONF>(was<OS_PATH_CONF>/analyzers/) and accepts forward slashes for nested paths.updateableparameter on the filter; whentrue, the filter runs in search-time analysis mode so its dictionary can be reloaded without a node restart.reload_cached_resourcesquery parameter on the Refresh search analyzer API (opensearch-project/index-management#1638) — triggersin-place reload of cached resources (such as Hunspell dictionary files) from disk.
Changes in this PR:
_analyzers/token-filters/hunspell.mdref_pathdescription: new path resolution, allowed characters now include forward slashes, and a 3.6 → 3.7 upgrade note (prefix existing values withanalyzers/to preserve the previous layout).dictionarydescription for the same path change.updateableparameter row.updateable: true), the two-step workflow, default-vs-truebehavior ofreload_cached_resources, and a completeindex-creation example using the filter as a
search_analyzer._im-plugin/refresh-analyzer.mdreload_cached_resourcesboolean, with a cross-link back to the Hunspell page.Issues Resolved
N/A — tracking the upstream PRs above.
Version
3.7
Frontend features
N/A — no OpenSearch Dashboards UI involved.
Checklist
Origin.