The Link-Template HTTP Header Field

Introduction defines a syntax for templates that, when expanded using a set of variables, results in a URI . This specification defines a HTTP header field for conveying templates for links in the headers of a HTTP message. It is complimentary to the Link header field defined in , which carries links directly.

Notational Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. This specification uses the following terms from : List, String, Display String, and Parameter.

The Link-Template Header Field The Link-Template header field is a Structured Field that serializes one or more links into HTTP message metadata. It is semantically equivalent to the Link header field defined in , except that the link target and link anchor can contain URI Templates . The Link-template header field's value is a List of Strings (see ). Each String contains a URI Template and can have Parameters that carry metadata associated with that template. For example: indicates that a resource with the relation type "item" for a given "username" can be found by expanding the "username" variable into the template given. The link target (see ) is determined by expanding the template and converting it to an absolute URI (if necessary). The link context and link relation type for the link (as defined in ) are conveyed using the 'anchor' and 'rel' Parameters, as they are for the Link header field in . Their values MUST be Strings. However, the 'anchor' Parameter MAY contain a URI Template. For example: Here, the link to the author for a particular book in a list of books can be found by following the link template. This specification defines additional semantics for the 'var-base' Parameter on templated links; see . The link's target attributes (as defined in ) are conveyed using other Parameters, in a manner similar to the Link header field. These Parameter values MUST be Strings, unless they contain non-ASCII characters, in which case they MUST be Display Strings. Note that some target attribute names will not serialize as Structured Field Parameter keys (see ). For example: Implementations MUST support all levels of template defined by in the link String and the 'anchor' Parameter.

The 'var-base' Parameter When a templated link has a 'var-base' Parameter, its value conveys a URI-reference that is used as a base URI for the variable names in the URI Template. This allows template variables to be globally identified, rather than specific to the context of use. Dereferencing the URI for a particular variable might lead to more information about the syntax or semantics of that variable; specification of particular formats for this information is out of scope for this document. To determine the URI for a given variable, the value given is used as a base URI in reference resolution (as specified in ). If the resulting URI is still relative, the context of the link is used as the base URI in a further resolution; see . For example: indicates that a resource with the relation type "https://example.org/rel/widget" can be found by expanding the "https://example.org/vars/widget_id" variable into the template given. If the current context of the message that the header appears within is "https://example.org/", the same information could be conveyed by this header field: