How to decide if a link should be part of the 'links' or 'actions' section?

49 views

Skip to first unread message

Ingo Griebsch

unread,

Nov 12, 2019, 4:02:28 PM11/12/19

to Siren Hypermedia

Hi all, I would like to understand into which section I should put specific links into, 'links' or 'actions'? I found the following gist: https://gist.github.com/kevinswiber/3066768

One of the links inside the '_links' section in the HAL example is marked as templated ("find": { "href": "/orders{?id}", "templated": true }). The others are not. Following the Siren example the not templated links are part of the 'links' section but the templated link is part of the 'actions' section.

Therefore I ask myself based on which rule I could/should decide if a link should be part of the 'links' section or if a link should be part of the 'actions' section?

Should a link be part of the 'links' section if the link represents a POST, PUT, PATCH or DELETE?

Should a link always be part of the 'links' section if the link represents a 'GET'?

Should a link be part of the 'links' section if the link contains templates?

Should I decide based on to which resource the link points?

Am I free to decide where to put the link? But if so how could I implement a client which should interpret the Hypermedia?

It would be really nice to understand in more detail in which way a link or an action should be defined.