Skip to content

GH-5797: Add RESPECT_JSONPROPERTY_ORDER to JsonSchemaGenerator #5847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
suryateja-g13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH-5797: Add RESPECT_JSONPROPERTY_ORDER to JsonSchemaGenerator #5847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...g-ai-model/src/main/java/org/springframework/ai/util/json/schema/JsonSchemaGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ public final class JsonSchemaGenerator {
* Initialize JSON Schema generators.
*/
static {
Module jacksonModule = new JacksonSchemaModule(JacksonOption.RESPECT_JSONPROPERTY_REQUIRED);
Module jacksonModule = new JacksonSchemaModule(JacksonOption.RESPECT_JSONPROPERTY_REQUIRED,
JacksonOption.RESPECT_JSONPROPERTY_ORDER);
Module openApiModule = new Swagger2Module();
Module springAiSchemaModule = PROPERTY_REQUIRED_BY_DEFAULT ? new SpringAiSchemaModule()
: new SpringAiSchemaModule(SpringAiSchemaModule.Option.PROPERTY_REQUIRED_FALSE_BY_DEFAULT);
Expand Down
47 changes: 47 additions & 0 deletions spring-ai-model/src/test/java/org/springframework/ai/util/json/JsonSchemaGeneratorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import com.fasterxml.jackson.annotation.JsonClassDescription;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.swagger.v3.oas.annotations.media.Schema;
import org.junit.jupiter.api.Test;
import tools.jackson.databind.JsonNode;
Expand Down Expand Up @@ -700,6 +701,17 @@ void throwExceptionWhenTypeIsNull() {
.hasMessage("type cannot be null");
}

@Test
void generateSchemaForTypeRespectsJsonPropertyOrder() throws Exception {
String schema = JsonSchemaGenerator.generateForType(OrderedPerson.class);
JsonNode schemaNode = JsonParser.getJsonMapper().readTree(schema);
JsonNode properties = schemaNode.get("properties");

assertThat(properties).isNotNull();
List<String> fieldNames = new java.util.ArrayList<>(properties.propertyNames());
assertThat(fieldNames).containsExactly("name", "email", "id");
}

static class TestMethods {

public void simpleMethod(String name, int age) {
Expand Down Expand Up @@ -775,6 +787,41 @@ record JSpecifyNullablePerson(int id, String name, @org.jspecify.annotations.Nul

}

@JsonPropertyOrder({ "name", "email", "id" })
static class OrderedPerson {

private int id;

private String name;

private String email;

public int getId() {
return this.id;
}

public void setId(int id) {
this.id = id;
}

public String getName() {
return this.name;
}

public void setName(String name) {
this.name = name;
}

public String getEmail() {
return this.email;
}

public void setEmail(String email) {
this.email = email;
}

}

static class Person {

private int id;
Expand Down