Core Link Definitions contain definitions that are specific to links.

Definitions

Definition Title Type Description
href HREF string A hyperlink URL
hrefTemplated Templated HREF string A hyperlink that is a URI template (RFC 6570)
isTemplated Is URI Templated? boolean Specifies whether or not a link is using URI templates
isDeprecated Is URI Deprecated? boolean Specifies whether or not a link is deprecated
queryStringURITemplate Query String URI Template string Specifies a query string URI template (RFC 6570)
rel Link Relation string A link relation
rels Link Relation Array array An array of link relations
label Label string Human-readable label for link
transclude Should transclude? boolean Specify whether or not a link should be transcluded

Schema

{
  "definitions": {
    "href": {
      "title": "HREF",
      "description": "A hyperlink URL",
      "type": "string"
    },
    "hrefTemplated": {
      "title": "Templated HREF",
      "description": "A hyperlink that is a URI template (RFC 6570)",
      "type": "string"
    },
    "isTemplated": {
      "title": "Is URI Templated?",
      "description": "Specifies whether or not a link is using URI templates",
      "type": "boolean"
    },
    "isDeprecated": {
      "title": "Is URI Deprecated?",
      "description": "Specifies whether or not a link is deprecated",
      "type": "boolean"
    },
    "queryStringURITemplate": {
      "title": "Query String URI Template",
      "description": "Specifies a query string URI template (RFC 6570)",
      "type": "string"
    },
    "rel": {
      "title": "Link Relation",
      "description": "A link relation",
      "type": "string"
    },
    "rels": {
      "title": "Link Relation Array",
      "description": "An array of link relations",
      "type": "array",
      "items": {
        "$ref": "#/definitions/rel"
      }
    },
    "label": {
      "title": "Label",
      "description": "Human-readable label for link",
      "type": "string"
    },
    "transclude": {
      "title": "Should transclude?",
      "description": "Specify whether or not a link should be transcluded",
      "type": "boolean"
    }
  }
}