spring-projects / spring-projects/spring-hateoas

Add sub resource support in RepresentationModel

Open
#920 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

in: mediatypes type: enhancement
Dominant language
Java
Stars
1.1k
Forks
476
PR merge metrics
No merged PRs in 30d

Description

The current RepresentationModel only supports links. Since many concrete representations support sub resources, e.g.:

  • _embedded in HAL / HAL Forms
  • entities in Siren
  • included in JSON:API

it would be nice if this concept is supported in the generic representation model, so it could be mapped automatically if this concept is supported by a concrete representation.

This is related to #864 and #968

Contributor guide

No contributing guide indexed for this repository

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

Start by reading RepresentationModel and the related issues #864 and #968, then compare how HAL/HAL Forms, Siren, and JSON:API represent sub resources. Done means the generic representation model supports sub resources and maps them automatically for concrete representations that support the concept.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.