spring-projects / spring-projects/spring-data-rest

Allow definition of rel to be used for single entity in @RestResource [DATAREST-73]

Open
#458 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: bug
Dominant language
Java
Stars
958
Forks
568
PR merge metrics
No merged PRs in 30d

Description

Oliver Drotbohm opened DATAREST-73 and commented

Currently you can customize the relation type to be used for the collection resource through @RestResource(rel = "people"). It would be cool if one could also explicitly define the relation type of the single entity rel such as @RestResource(singleRel = "person").

Might be a good idea to deprecate rel and rather lookup a collectionRel attribute to create symmetry between the attribute names


No further details from DATAREST-73

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names @RestResource and links DATAREST-73; start by locating that annotation and the code or tests that consume its relation attributes. Confirm whether separate single-entity and collection relation names, including the proposed rel/collectionRel compatibility, are required before considering the work done.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.