spring-projects / spring-projects/spring-data-rest
Metadata: Serialized enum values should use ALPS 'ext' rather than 'doc' properties [DATAREST-1484]
@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
Gerald Melles opened DATAREST-1484 and commented
The serialization of enum values into the same type of 'doc' text properties as the Description annotations makes processing them rather difficult. The 'doc' property is intended for human-readable text; I would propose the use of the 'ext' tag instead as that is actually intended for extending the ALPS specification with custom properties.
That said, bearing in mind that the 'ext' 'id' property is the only way to mark this as an enum value but is supposed to be a 'document-wide unique identifier' and that the ALPS proposal contains little room for other options, we may have reached its limits in any case. With the draft having expired five years ago, I would be open to the idea of drafting a new version altogether (being less than fond of most alternatives out there). SDR could synergize quite well that
No further details from DATAREST-1484
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.