-
_links
- Links (to URIs)-
{relation name}
A resource may have multiple links that share the same link relation. For link relations that may have multiple links, we use an array of links.
-
curies
(array)CURIE help providing links to resource documentation. HAL gives you a reserved link relation 'curies' which you can use to hint at the location of resource documentation.
There can be multiple links in the 'curies' section. They come with a 'name' and a templated 'href' which must contain the {rel} placeholder.
Links in turn can then prefix their 'rel' with a CURIE name. Associating the
latest-posts
link with the doc documentation CURIE results in a link 'rel' set todoc:latest-posts
.To retrieve documentation about the
latest-posts
resource, the client will expand the associated CURIE link with the actual link's 'rel'. This would result in a URLhttp://haltalk.herokuapp.com/docs/latest-posts
which is expected to return documentation about this resource.-
Elements
- (object)
name
href
templated
- (object)
-
-
-
_embedded
- Embedded Resources (i.e. other resources contained within them) -
{additional properties} - State (your bog standard JSON or XML data)
href
(required)templated
Original specification: HAL - Hypertext Application Language