GH-1335: Add JSON schema property order support #1695
Closed
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
Fixes: spring-projects#1335 spring-projects#1335 Add support for maintaining JSON property order in generated schemas using @JsonPropertyOrder. Users can now control the order of properties in their JSON schemas by annotating their classes/records with @JsonPropertyOrder. - Add JacksonOption.RESPECT_JSONPROPERTY_ORDER to BeanOutputConverter - Add test to verify schema property ordering - Update documentation with property ordering example
| record TestClassWithJsonPropertyOrder( | ||
| @JsonProperty("string_property") @JsonPropertyDescription("string_property_description") String someString, | ||
|
|
||
| @JsonProperty(required = true, value = "foo_property") String foo, |
There was a problem hiding this comment.
Just as a validation, we could perhaps change the order here to make sure the actual order from "JsonPropertyOrder" dictates the ordering. will change it when merging.
|
The changes LGTM. We also can add/update test at the OpenAiChatModelResponseFormatIT as quoted from the issue. Will update this when merging. |
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.
Fixes: #1335
#1335
Add support for maintaining JSON property order in generated schemas using @JsonPropertyOrder. Users can now control the order of properties in their JSON schemas by annotating their classes/records with @JsonPropertyOrder.