< draft-nottingham-link-template-03.txt   draft-ietf-httpapi-link-template-00.txt >
Network Working Group M. Nottingham Building Blocks for HTTP APIs M. Nottingham
Internet-Draft 1 September 2021 Internet-Draft 28 April 2022
Intended status: Standards Track Intended status: Standards Track
Expires: 5 March 2022 Expires: 30 October 2022
The Link-Template HTTP Header Field The Link-Template HTTP Header Field
draft-nottingham-link-template-03 draft-ietf-httpapi-link-template-00
Abstract Abstract
This specification defines the Link-Template HTTP header field, This specification defines the Link-Template HTTP header field,
providing a means for describing the structure of a link between two providing a means for describing the structure of a link between two
resources, so that new links can be generated. resources, so that new links can be generated.
Note to Readers About This Document
The issues list can be found at https://github.com/mnot/I-D/labels/ This note is to be removed before publishing as an RFC.
link-template (https://github.com/mnot/I-D/labels/link-template).
The most recent (often, unpublished) draft is at The latest revision of this draft can be found at https://ietf-wg-
https://mnot.github.io/I-D/link-template/ (https://mnot.github.io/I- httpapi.github.io/link-template/draft-ietf-httpapi-link-
D/link-template/). template.html. Status information for this document may be found at
https://datatracker.ietf.org/doc/draft-ietf-httpapi-link-template/.
Recent changes are listed at https://github.com/mnot/I-D/commits/gh- Discussion of this document takes place on the Building Blocks for
pages/link-template (https://github.com/mnot/I-D/commits/gh-pages/ HTTP APIs Working Group mailing list (mailto:httpapi@ietf.org), which
link-template). is archived at https://mailarchive.ietf.org/arch/browse/httpapi/.
Source for this draft and an issue tracker can be found at
https://github.com/ietf-wg-httpapi/link-template.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on 5 March 2022. This Internet-Draft will expire on 30 October 2022.
Copyright Notice Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the Copyright (c) 2022 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/ Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document. license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text extracted from this document must include Revised BSD License text as
as described in Section 4.e of the Trust Legal Provisions and are described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License. provided without warranty as described in the Revised BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 2 1.1. Notational Conventions . . . . . . . . . . . . . . . . . 2
2. The Link-Template Header Field . . . . . . . . . . . . . . . 3 2. The Link-Template Header Field . . . . . . . . . . . . . . . 3
2.1. The 'var-base' parameter . . . . . . . . . . . . . . . . 3 2.1. The 'var-base' parameter . . . . . . . . . . . . . . . . 3
3. Security Considerations . . . . . . . . . . . . . . . . . . . 4 3. Security Considerations . . . . . . . . . . . . . . . . . . . 4
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
5. Normative References . . . . . . . . . . . . . . . . . . . . 4 5. Normative References . . . . . . . . . . . . . . . . . . . . 4
skipping to change at page 2, line 44 skipping to change at page 2, line 44
This specification defines a HTTP header field [HTTP] for conveying This specification defines a HTTP header field [HTTP] for conveying
templates for links in the headers of a HTTP message. It is templates for links in the headers of a HTTP message. It is
complimentary to the Link header field defined in Section 3 of complimentary to the Link header field defined in Section 3 of
[WEB-LINKING], which carries links directly. [WEB-LINKING], which carries links directly.
1.1. Notational Conventions 1.1. Notational Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in
14 [RFC2119] [RFC8174] when, and only when, they appear in all BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
This document uses the Augmented BNF defined in [HTTP] to specify This document uses the Augmented BNF defined in [HTTP] to specify
valid protocol elements. Additionally, it uses the modified valid protocol elements. Additionally, it uses the modified
"parameter" rule from [RFC5987] and the "URI-Template" rule from "parameter" rule from [RFC5987] and the "URI-Template" rule from
[URI-TEMPLATE]. [URI-TEMPLATE].
2. The Link-Template Header Field 2. The Link-Template Header Field
The Link-Template header field provides a means for serialising one The Link-Template header field provides a means for serialising one
skipping to change at page 5, line 7 skipping to change at page 5, line 7
Transfer Protocol (HTTP) Field Name Registry. Transfer Protocol (HTTP) Field Name Registry.
Field Name: Link-Template Field Name: Link-Template
Status: permanent Status: permanent
Specification document: [this document] Specification document: [this document]
5. Normative References 5. Normative References
[HTTP] Fielding, R. T., Nottingham, M., and J. Reschke, "HTTP [HTTP] Fielding, R. T., Nottingham, M., and J. Reschke, "HTTP
Semantics", Work in Progress, Internet-Draft, draft-ietf- Semantics", Work in Progress, Internet-Draft, draft-ietf-
httpbis-semantics-18, 18 August 2021, httpbis-semantics-19, 12 September 2021,
<https://www.ietf.org/archive/id/draft-ietf-httpbis- <https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-
semantics-18.txt>. semantics-19>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/rfc/rfc2119>.
[RFC5987] Reschke, J., "Character Set and Language Encoding for [RFC5987] Reschke, J., "Character Set and Language Encoding for
Hypertext Transfer Protocol (HTTP) Header Field Hypertext Transfer Protocol (HTTP) Header Field
Parameters", RFC 5987, DOI 10.17487/RFC5987, August 2010, Parameters", RFC 5987, DOI 10.17487/RFC5987, August 2010,
<https://www.rfc-editor.org/info/rfc5987>. <https://www.rfc-editor.org/rfc/rfc5987>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/rfc/rfc8174>.
[URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005, RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>. <https://www.rfc-editor.org/rfc/rfc3986>.
[URI-TEMPLATE] [URI-TEMPLATE]
Gregorio, J., Fielding, R., Hadley, M., Nottingham, M., Gregorio, J., Fielding, R., Hadley, M., Nottingham, M.,
and D. Orchard, "URI Template", RFC 6570, and D. Orchard, "URI Template", RFC 6570,
DOI 10.17487/RFC6570, March 2012, DOI 10.17487/RFC6570, March 2012,
<https://www.rfc-editor.org/info/rfc6570>. <https://www.rfc-editor.org/rfc/rfc6570>.
[WEB-LINKING] [WEB-LINKING]
Nottingham, M., "Web Linking", RFC 8288, Nottingham, M., "Web Linking", RFC 8288,
DOI 10.17487/RFC8288, October 2017, DOI 10.17487/RFC8288, October 2017,
<https://www.rfc-editor.org/info/rfc8288>. <https://www.rfc-editor.org/rfc/rfc8288>.
Author's Address Author's Address
Mark Nottingham Mark Nottingham
Prahran Prahran
VIC
Australia Australia
Email: mnot@mnot.net Email: mnot@mnot.net
URI: https://www.mnot.net/ URI: https://www.mnot.net/
 End of changes. 20 change blocks. 
31 lines changed or deleted 32 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/