spring-projects / spring-projects/spring-data-rest
PersistentEntityToJsonSchemaConverter does not honor @Description annotation [DATAREST-679]
@odrotbohm is already working on this.
Since Dec 31, 2020.
- Dominant language
- Java
- Stars
- 958
- Forks
- 568
- PR merge metrics
- No merged PRs in 30d
Description
Ryon Day opened DATAREST-679 and commented
I was puzzled to discover that in my project, annotating fields within domain objects with the @Description annotation did not result in a corresponding description element within the JSON schema.
I ran through the code in the IntelliJ debugger and found that the "fallback" property of AnnotationBasedResourceDescription overrides the actual message in the same class. If SDR cannot find a message with the key rest.description.$type.$field it will return null.
This seems to be the opposite of the desired behavior; it should use the explicitly stated value of the description annotation's value, then look for the fallback, then return null.
Affects: 2.3.2 (Fowler SR2), 2.4 GA (Gosling)
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.