spring-projects / spring-projects/spring-hateoas
Too much noise in rendered curie links
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 476
- PR merge metrics
- No merged PRs in 30d
Description
spring-hateoas version: 1.3.0-SNAPSHOT
If curie links are rendered, DefaultCurieProvider causes all curie links to be rendered, not checking, whether they are actually gonna be used or not. Afaict the spec is not forbidding this, but I was not able to find any example stating the opposite. Nevertheless it might be confusing for external api consumer, seeing a bunch of obviously non-related and unused curie links rendered, which sole purpose are for legacy controllers using deprecated rel hrefs e.g.
Test cases: https://github.com/slinstaedt/spring-hateoas-testcase
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with DefaultCurieProvider and the linked spring-hateoas-testcase to reproduce how curie links are rendered. Trace which curies are included when only some rels are used, then verify that unrelated curie links are omitted from the rendered API output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100