The target URL indicated in the href
property is related to the current resource according to the defined semantics of the link relationship name.
A link relationship may consist of one or more links, with varying titles and types.
Property | Description |
---|---|
href |
The hypertext reference to a related resource. |
templated |
Whether the given href is a templated URL using RFC 6570 format. |
title |
A descriptive title for the link. |
type |
A media type hint for the resource identified by the href. This can be useful to indicate alternate representations of a resource, such as a PDF ( If this property is missing, the assumed media type of the target URL is the default API media type of |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "The target URL indicated in the `href` property is related to the current\nresource according to the defined semantics of the link relationship name.\n\nA link relationship may consist of one or more links, with varying titles and\ntypes.",
"oneOf": [
{
"properties": {
"href": {
"description": "The hypertext reference to a related resource.",
"format": "uri",
"type": "string"
},
"templated": {
"default": false,
"description": "Whether the given href is a templated URL using [RFC\n6570](https://tools.ietf.org/html/rfc6570) format.",
"type": "boolean"
},
"title": {
"description": "A descriptive title for the link.",
"type": "string"
},
"type": {
"default": "application/vnd+shootproof.json",
"description": "A media type hint for the resource identified by the href. This can be\nuseful to indicate alternate representations of a resource, such as a PDF\n(`application/pdf`), CSV (`text/csv`), or JPEG (`image/jpeg`) file.\n\nIf this property is missing, the assumed media type of the target URL is\nthe default API media type of `application/vnd+shootproof.json`.",
"type": "string"
}
},
"title": "Single Link",
"type": "object"
},
{
"items": {
"$ref": "#/components/schemas/Link/oneOf/0"
},
"title": "Array of Links",
"type": "array"
}
],
"title": "Hypermedia Link Relationship"
}