You are here

Home » API reference » JSON:API Hypermedia 8

jsonapi_hypermedia.link_relation_types.yml in JSON:API Hypermedia 8

jsonapi_hypermedia.link_relation_types.yml

File

jsonapi_hypermedia.link_relation_types.yml
View source 
  1. # JSON:API Hypermedia's link relation types.

  2. # See https://tools.ietf.org/html/rfc8288#section-2.1.2

  3. add:

  4.   description: "The link's target points to a resource where a user agent can cause an addition to the link's context."

  5.   reference: '[https://jsonapi.org/format/#document-links-link-relations]'

  6. update:

  7.   description: "The link's target points to a resource where a user agent can cause an update the link's context."

  8.   reference: '[https://jsonapi.org/format/#document-links-link-relations]'

  9. remove:

  10.   description: "The link's target points to a resource where a user agent can cause a removal of all or part of the link's context."

  11.   reference: '[https://jsonapi.org/format/#document-links-link-relations]'

  12. # relate:

  13. #   description: "The link's target points to a resource where a user agent can cause a direct or indirect relationship to be established with the link's context."

  14. #   reference: '[https://jsonapi.org/format/#document-links-link-relations]'