spring-projects / spring-projects/spring-data-rest
Documentation configuring-the-rest-url-path.adoc uses the wrong annotation or attribute
Open
Nobody has claimed this yet.
type: documentation
- Dominant language
- Java
- Stars
- 958
- Forks
- 568
- PR merge metrics
- No merged PRs in 30d
Description
At line 100 of 3.6.2, the documentation says that we can use the "rel" attribute for the @RepositoryRestResource, which doesn't have it.
I believe that it should just @RestResource there or it should use either or both itemRel or collectionRel.
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.
Research direction
Open configuring-the-rest-url-path.adoc at line 100 in the 3.6.2 documentation and compare the stated rel attribute with the @RepositoryRestResource and @RestResource APIs. Confirm whether itemRel or collectionRel are supported, then update the example and verify that the corrected documentation renders properly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100