Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add sub resource support in RepresentationModel #920

Open
toedter opened this issue Mar 24, 2019 · 2 comments
Open

Add sub resource support in RepresentationModel #920

toedter opened this issue Mar 24, 2019 · 2 comments
Labels
in: mediatypes Media type related functionality type: enhancement

Comments

@toedter
Copy link

toedter commented Mar 24, 2019 •
edited
Loading

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
odrotbohm added a commit that referenced this issue May 7, 2020
@odrotbohm
#864 - Introduced HalModelBuilder.
2cab91a 
HalModelBuilder expose HAL-idiomatic API to set up representations. That includes embeds, previews and syntactic sugar around the inclusion of potentially empty collections as embeds.

Related tickets: #175, #193, #270, #920.
Original pull request: #1273.
@odrotbohm
Copy link
Member

We took a first stab at a HAL specific model builder with 2cab91a. See the updated reference documentation for details.

@odrotbohm odrotbohm added in: mediatypes Media type related functionality type: enhancement labels May 7, 2020
@ccit-spence
Copy link

The current documentation does not show how this would work for a PagedModel. Is this something that can be documented? Are there current examples?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
in: mediatypes Media type related functionality type: enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@odrotbohm @toedter @ccit-spence