JSON serialization for Web Linking
draft-pot-json-link-02
Network Working Group E. Pot
Internet-Draft
Intended status: Standards Track G. Sullice
Expires: May 5, 2021 Acquia, Inc.
November 01, 2020
JSON serialization for Web Linking
draft-pot-json-link-02
Abstract
This specification defines a serialization of Web Linking [RFC8288]
in the JSON [RFC8259] format.
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 May 5, 2021.
Copyright Notice
Copyright (c) 2020 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.
Pot & Sullice Expires May 5, 2021 [Page 1]
Internet-Draft JSON serialization for Web Linking November 2020
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. The link object. . . . . . . . . . . . . . . . . . . . . 3
2.1.1. rel . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.2. href . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.3. anchor . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.4. Other attributes . . . . . . . . . . . . . . . . . . 4
2.1.5. Extension Attributes . . . . . . . . . . . . . . . . 4
2.1.6. Example . . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Lists of links . . . . . . . . . . . . . . . . . . . . . 4
2.2.1. Example . . . . . . . . . . . . . . . . . . . . . . . 4
2.3. Document-level links . . . . . . . . . . . . . . . . . . 5
2.3.1. Example . . . . . . . . . . . . . . . . . . . . . . . 5
3. IANA considerations . . . . . . . . . . . . . . . . . . . . . 6
4. References . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.1. Normative References . . . . . . . . . . . . . . . . . . 6
4.2. Informative References . . . . . . . . . . . . . . . . . 6
Appendix A. Typescript definitions . . . . . . . . . . . . . . . 7
Appendix B. JSON-SCHEMA definitions . . . . . . . . . . . . . . 7
B.1. Link . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Appendix C. Changelog . . . . . . . . . . . . . . . . . . . . . 8
C.1. Changes since -?? . . . . . . . . . . . . . . . . . . . . 8
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 8
1. Introduction
There are many JSON-based standards and formats that require the need
to express a link. Examples can be found in [draft-kelly-json-hal],
[JSON-API], [WEBTHING], [draft-nottingham-json-home],
[COLLECTIONJSON], [SIREN] and many others.
Because there hasn't been an accepted reference for serializing Web
Links in JSON, it's typical for authors of new formats to invent
their own. This has resulted in many minor differences between
serializations, making it difficult to write generic parsers.
This document is an attempt to define a standard JSON serialization
for Web linking. A primary goal is to define a format that's
relatively uncontroversial and similar to existing serializations.
Furthermore, this specification defines an optional format for groups
of links and a recommendation for defining document-wide links.
Pot & Sullice Expires May 5, 2021 [Page 2]
Internet-Draft JSON serialization for Web Linking November 2020
2. Format
2.1. The link object.
A link will be encoded as a JSON [RFC8259] object. The object might
support the properties from the following chapters, but only "rel"
Show full document text