Linkset: Media Types and a Link Relation Type for Link Sets
draft-ietf-httpapi-linkset-00
Network Working Group E. Wilde
Internet-Draft Axway
Intended status: Informational H. Van de Sompel
Expires: July 18, 2021 Data Archiving and Networked Services
January 14, 2021
Linkset: Media Types and a Link Relation Type for Link Sets
draft-ietf-httpapi-linkset-00
Abstract
This specification defines two document formats and respective media
types for representing sets of links as stand-alone resources. One
format is JSON-based, the other aligned with the format for
representing links in the HTTP "Link" header field. This
specification also introduces a link relation type to support
discovery of sets of links.
Note to Readers
Please discuss this draft on the "Building Blocks for HTTP APIs"
mailing list (<https://www.ietf.org/mailman/listinfo/httpapi>).
Online access to all versions and files is available on GitHub
(<https://github.com/ietf-wg-httpapi/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 July 18, 2021.
Wilde & Van de Sompel Expires July 18, 2021 [Page 1]
Internet-Draft Linkset January 2021
Copyright Notice
Copyright (c) 2021 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 Sets of Links . . . . . . . . . . . . . 5
4.1. HTTP Link Document Format: application/linkset . . . . . 6
4.2. JSON Document Format: application/linkset+json . . . . . 6
4.2.1. Set of Links . . . . . . . . . . . . . . . . . . . . 7
4.2.2. Link Context Object . . . . . . . . . . . . . . . . . 7
4.2.3. Link Target Object . . . . . . . . . . . . . . . . . 8
4.2.4. Link Target Attributes . . . . . . . . . . . . . . . 9
5. The "linkset" Relation Type for Linking to a Set of Links . . 13
6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1. Set of Links Provided as application/linkset . . . . . . 14
6.2. Set of Links Provided as application/linkset+json . . . . 15
6.3. Discovering a Link Set via the "linkset" Link Relation
Type . . . . . . . . . . . . . . . . . . . . . . . . . . 18
7. Implementation Status . . . . . . . . . . . . . . . . . . . . 18
7.1. GS1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
7.2. Open Journal Systems (OJS) . . . . . . . . . . . . . . . 19
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 19
8.1. Link Relation Type: linkset . . . . . . . . . . . . . . . 19
8.2. Media Type: application/linkset . . . . . . . . . . . . . 20
8.2.1. IANA Considerations . . . . . . . . . . . . . . . . . 20
8.3. Media Type: application/linkset+json . . . . . . . . . . 21
9. Security Considerations . . . . . . . . . . . . . . . . . . . 22
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 23
10.1. Normative References . . . . . . . . . . . . . . . . . . 23
10.2. Informative References . . . . . . . . . . . . . . . . . 24
Wilde & Van de Sompel Expires July 18, 2021 [Page 2]
Show full document text