fix: correct IndexSpecs code examples in extension docs#591
Merged
Conversation
Update the index declaration examples to use explicit generic type parameters and proper Set conversion for multi-value indexes: - Replace `import static` with explicit `IndexSpecs.<E, K>` calls - Convert List tags to HashSet in multi-value index examples - Apply fixes to next, 2.22, 2.23, and 2.24 docs
f2c-ci-robot
Bot
added
do-not-merge/release-note-label-needed
JohnNiang
reviewed
May 11, 2026
Update the docs example to return Set.of() when tags is null and return the existing tags object instead of creating a new HashSet copy. Apply the change to the main docs and versioned docs (v2.22, v2.23, v2.24) to simplify the example and avoid unnecessary allocations.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: JohnNiang The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
f2c-ci-robot
Bot
added
the
approved
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.
Summary
This PR fixes the index declaration code examples in the custom model documentation. The current examples have several issues that prevent them from compiling or working correctly:
IndexSpecs.single()andIndexSpecs.multi()require explicit generic types (e.g.,IndexSpecs.<Moment, String>single(...)) because Java cannot infer them from static imports alone.multiexample assumesgetTags()returns aSet, but it typically returns aList. The example now wraps it withnew HashSet<>()to match the expectedSet<String>return type.Changes
Updated the following files:
docs/developer-guide/plugin/api-reference/server/extension.md(next)versioned_docs/version-2.22/.../extension.mdversioned_docs/version-2.23/.../extension.mdversioned_docs/version-2.24/.../extension.md