Linkset: Media Types and a Link Relation Type for Link Sets
draft-wilde-linkset-01

Document Type Active Internet-Draft (individual)
Last updated 2017-09-06
Replaces draft-wilde-linkset-link-rel
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                           E. Wilde
Internet-Draft                                           CA Technologies
Intended status: Informational                          H. Van de Sompel
Expires: March 10, 2018                   Los Alamos National Laboratory
                                                       September 6, 2017

      Linkset: Media Types and a Link Relation Type for Link Sets
                         draft-wilde-linkset-01

Abstract

   This specification defines two media types and a link relation type
   for sets of links.  The media types can be used to represents links
   in a standalone fashion, in one case in the native format used in the
   HTTP Link header, and in the other case in a JSON-based format.  The
   link relation can be used to reference these kind of standalone link
   sets, so that a resource can indicate that additional links putting
   it into context are available someplace else.  One typical scenario
   is when the number of links to put in an HTTP Link header field
   becomes too big, and thus these links should be provided by a
   distinct resource.

Note to Readers

   Please discuss this draft on the ART mailing list
   (<https://www.ietf.org/mailman/listinfo/art>).

   Online access to all versions and files is available on GitHub
   (<https://github.com/dret/I-D/tree/master/linkset>).

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 https://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 10, 2018.

Wilde & Van de Sompel    Expires March 10, 2018                 [Page 1]
Internet-Draft                   Linkset                  September 2017

Copyright Notice

   Copyright (c) 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
   (https://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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Third-Party Links . . . . . . . . . . . . . . . . . . . .   4
     3.2.  Challenges Writing to HTTP Link Header Field  . . . . . .   4
     3.3.  Large Number of Links . . . . . . . . . . . . . . . . . .   5
   4.  Document Formats for Link Sets  . . . . . . . . . . . . . . .   5
     4.1.  HTTP Link Document Format: application/linkset  . . . . .   6
     4.2.  JSON Document Format: application/linkset+json  . . . . .   6
       4.2.1.  Link Sets . . . . . . . . . . . . . . . . . . . . . .   6
       4.2.2.  Links . . . . . . . . . . . . . . . . . . . . . . . .   6
       4.2.3.  Link Target Attributes  . . . . . . . . . . . . . . .   8
       4.2.4.  Extension Target Attributes . . . . . . . . . . . . .  10
   5.  The "linkset" Relation Type for Linking to Link Sets  . . . .  10
   6.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .  11
     6.1.  Links Provided in the Header of the Link Set Resource . .  11
     6.2.  Links Provided in the Body of the Link Set Resource,
           Link Set Serialized as application/linkset+json . . . . .  13
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  15
     7.1.  Link Relation Type: linkset . . . . . . . . . . . . . . .  15
     7.2.  Media Type: application/linkset . . . . . . . . . . . . .  16
       7.2.1.  IANA Considerations . . . . . . . . . . . . . . . . .  16
     7.3.  Media Type: application/linkset+json  . . . . . . . . . .  17
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .  18
   9.  Normative References  . . . . . . . . . . . . . . . . . . . .  18
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  19
Show full document text