Network Working GroupM. Nottingham
Internet-DraftSeptember 22, 2017
Intended status: Standards Track
Expires: March 26, 2018

The Link-Template HTTP Header Field

draft-nottingham-link-template-03

Abstract

This specification defines the Link-Template HTTP header field, providing a means for describing the structure of a link between two resources, so that new links can be generated.

Note to Readers

The issues list can be found at https://github.com/mnot/I-D/labels/link-template.

The most recent (often, unpublished) draft is at https://mnot.github.io/I-D/link-template/.

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress”.

This Internet-Draft will expire on March 26, 2018.

Copyright Notice

Copyright © 2017 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

1. Introduction

[RFC6570] defines a syntax for templates that, when expanded using a set of variables, results in a URI [RFC3986].

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 [I-D.nottingham-rfc5988bis], which carries links directly.

1.1. Notational Conventions

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 [RFC2119].

This document uses the Augmented BNF defined in [RFC7230] to specify valid protocol elements. Additionally, it uses the modified “parameter” rule from [RFC5987], and the “URI-Template” rule from [RFC6570].

3. Security Considerations

The security consideration for the Link header field in [I-D.nottingham-rfc5988bis] and those for URI Templates [RFC6570] both apply.

4. IANA Considerations

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]

5. Normative References

[I-D.nottingham-rfc5988bis]
Nottingham, M., “Web Linking”, Internet-Draft draft-nottingham-rfc5988bis-08 (work in progress), August 2017.
[RFC2119]
Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>.
[RFC3986]
Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax”, STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, <https://www.rfc-editor.org/info/rfc3986>.
[RFC5987]
Reschke, J., “Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters”, RFC 5987, DOI 10.17487/RFC5987, August 2010, <https://www.rfc-editor.org/info/rfc5987>.
[RFC6570]
Gregorio, J., Fielding, R., Hadley, M., Nottingham, M., and D. Orchard, “URI Template”, RFC 6570, DOI 10.17487/RFC6570, March 2012, <https://www.rfc-editor.org/info/rfc6570>.
[RFC7230]
Fielding, R., Ed. and J. Reschke, Ed., “Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing”, RFC 7230, DOI 10.17487/RFC7230, June 2014, <https://www.rfc-editor.org/info/rfc7230>.

Author's Address

Mark Nottingham
Email: mnot@mnot.net
URI: https://www.mnot.net/