fix: correct ToolDefinition.builder() usage in docs #3431
Merged
+3
−3
Conversation
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
Signed-off-by: SexyProgrammer <[email protected]>
|
Thanks for the PR! |
ilayaperumalg
added
documentation
spring-builds
pushed a commit
that referenced
this pull request
Jun 4, 2025
Signed-off-by: SexyProgrammer <[email protected]> (cherry picked from commit 8af1d39)
namsoo2
pushed a commit
to namsoo2/spring-ai
that referenced
this pull request
Jun 9, 2025
…3431) Auto-cherry-pick to 1.0.x Signed-off-by: SexyProgrammer <[email protected]> Signed-off-by: minsoo.nam <[email protected]>
chedim
pushed a commit
to couchbaselabs/spring-ai
that referenced
this pull request
Sep 19, 2025
…3431) Auto-cherry-pick to 1.0.x Signed-off-by: SexyProgrammer <[email protected]>
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.
📄 Documentation Bug
Problem:
In the current documentation or code samples,
ToolDefinition.builder(method)is used to build a ToolDefinition from aMethod. However,ToolDefinitiondoes not have such a static builder method that accepts aMethod— this causes confusion and runtime errors.Correct Usage:
It should be
ToolDefinitions.builder(method)(note the plural form), as defined in the Spring AI tooling API.Suggested Fix:
Update all references of
ToolDefinition.builder(method)toToolDefinitions.builder(method)in documentation or samples.Version: Spring AI 1.0.0
Thanks for your awesome work!
I may be wrong here, and if this was intentional, feel free to close the PR.
Just wanted to help improve the docs and avoid confusion for others. Thanks again!