spring-projects / spring-projects/spring-ai
Consolidate JSON Schema generation documentation between Tool Calling and Structured Output Conversion
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.5k
- Forks
- 2.9k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 6
Description
Following the consolidation in #5897, BeanOutputConverter now delegates to JsonSchemaGenerator for schema generation, aligning the behavior between tool calling and structured output conversion.
The reference documentation for these two features should be reviewed and consolidated, since they now share the same schema generation logic — in particular, the supported annotations (@ToolParam, @JsonProperty, @Schema, @Nullable) and the default required-property behavior.
Discussed in #5897.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the reference documentation for Tool Calling and Structured Output Conversion, then compare how they describe BeanOutputConverter and JsonSchemaGenerator. Consolidate the sections so the supported annotations (@ToolParam, @JsonProperty, @Schema, @Nullable) and default required-property behavior are documented consistently, using #5897 for context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100