spring-projects / spring-projects/spring-data-rest
Customize JSON Schema for Value object properties [DATAREST-1178]
Open
@odrotbohm is already working on this.
Since Dec 31, 2020.
type: enhancement
- Dominant language
- Java
- Stars
- 958
- Forks
- 568
- PR merge metrics
- No merged PRs in 30d
Description
Patrik Mihalcin opened DATAREST-1178 and commented
When I use value objects in my domain model, I usually unwrap properties using @JsonUnwrapped.
This actually leads to inconsistency between generated JSON schema and serialized JSON response. Schema contains object properties with reference to definitions, so it is required to flatten out JSON schema on the client.
My current workaround is to use, what is not ideal:
@Override
public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
MetadataConfiguration metadataConfiguration = config.getMetadataConfiguration();
metadataConfiguration.registerFormattingPatternFor("value-object", Description.class);
super.configureRepositoryRestConfiguration(config);
}
I think this could be improved
1 votes, 1 watchers
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.
Assessment
This issue has not been assessed yet.