Consolidate JSON Schema generation documentation between Tool Calling and Structured Output#6160
Open
ChoMinGi wants to merge 1 commit into
Open
Consolidate JSON Schema generation documentation between Tool Calling and Structured Output#6160ChoMinGi wants to merge 1 commit into
ChoMinGi wants to merge 1 commit into
Conversation
…entation - Add JSON Schema Customization section to structured-output-converter.adoc - Add cross-reference from tools.adoc to structured-output-converter.adoc spring-projects#5915 Signed-off-by: Mingi Cho <81455273+ChoMinGi@users.noreply.github.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
1 participant
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.
Fixes #5915
Following the consolidation in #5897,
BeanOutputConverternow delegates toJsonSchemaGeneratorfor schema generation, aligning the behavior between tool calling and structured output conversion.However, the documentation for these two features remained separate — the supported annotations and default required-property behavior were only documented in the Tool Calling page.
structured-output-converter.adocdocumenting the supported annotations for description (@JsonClassDescription,@JsonPropertyDescription,@Schema) and required/optional status (@JsonProperty,@Schema,@Nullable)tools.adoctostructured-output-converter.adoc, noting thatBeanOutputConvertershares the sameJsonSchemaGenerator