The Link-Template HTTP Header Field

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 templated links in the headers of a HTTP message. It is complimentary to the Link header field , which carries links directly.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in .

This document uses the Augmented BNF defined in to specify valid protocol elements. Additionally, it uses the modified "parameter" rule from , and the "URI-Template" rule from .

The Link-Template entity-header field provides a means for serialising one or more links into HTTP headers. It is semantically equivalent to the Link header field , except that it uses URI Templates to convey the structure of links.

" *( ";" parameter ) ]]> For example:

; rel="http://example.org/rel/user" ]]> indicates that a resource with the relation type "http://example.org/rel/user" can be found by interpolating the "username" variable into the template given. The target for the link (as defined by ) is the result of expanding the URI Template (being converted to an absolute URI after expansion, if necessary). The context, relation type and target attributes for the link are determined as defined for the Link header field in . The parameters on a linkt-value have identical semantics to those of a Link header field . This includes (but is not limited to) the use of the "rel" parameter to convey the relation type, the "anchor" parameter to modify the context IRI, and so on. Likewise, the requirements for parameters on linkt-values are the same as those for a Link header field; in particular, the "rel" parameter MUST NOT appear more than once, and if it does, the linkt-value MUST be ignored by parsers. This specification defines additional semantics for the "var-base" parameter on linkt-values; see below.

When a linkt-value 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 mechanism 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:

; rel="http://example.org/rel/widget"; var-base="http://example.org/vars/" ]]> indicates that a resource with the relation type "http;//example.org/rel/widget" can be found by interpolating the "http://example.org/vars/widget_id" variable into the template given. If the current context of the link is "http://example.org/", the same information could be conveyed by this header field:

; rel="http://example.org/rel/widget"; var-base="/vars/" ]]>

The security consideration for the Link header field in and those for URI Templates both apply.

This specification enters the "Link-Template" into the registry of Permanent Message Header Field Names. Header Field Name: Link-Template Protocol: http Status: Reference: [this document]