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.

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

Find additional information for RelationLink #18

Open
bruderj15 opened this issue Dec 26, 2024 · 0 comments
Open

Find additional information for RelationLink #18

bruderj15 opened this issue Dec 26, 2024 · 0 comments
Labels
good first issue Good for newcomers improvement Improve existing feature

Comments

@bruderj15
Copy link
Owner

bruderj15 commented Dec 26, 2024

RelationLink describes the relation of one resource to another via a link.

Some content-types like application/vnd.collection+json (#15) or application/prs.hal-forms+json (#17) provide predefined attributes to describe the endpoint behind the referencing link in more detail.

For example, part of a application/prs.hal-forms+json response may look like:

{
  "_templates" : {
    "default" : {
      "contentType" : "application/json",
      "href": "/api/resource/1",
      "method": "PUT",
      "properties": [
         {
           "name": "name",
           "required": true,
           "type": "text"
         }
      ]
    }
  }
}

Information like contentType and method are easily accessible for us.
There is much more information around.

Can we utilize combinators Summary and Description? (#23)
Can we add information regarding a POST-Requests body?
Can we add information regarding Query-Params?
And so on...

This is just about gathering the information in HasRelationLink and storing it in RelationLink.
Concrete usage in explicit resource-types is obviously handled by the MimeRender instances for the corresponding content-types.

Gather all possible information we can find and make separate issues for each of them.

@bruderj15 bruderj15 added good first issue Good for newcomers improvement Improve existing feature labels Dec 26, 2024
@bruderj15 bruderj15 changed the title Find additional information for RelationLink & RelationParam Find additional information for RelationLink Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers improvement Improve existing feature
Projects
None yet
Development

No branches or pull requests

1 participant