JSON Hypermedia Links Notation
draft-wparad-json-links-03

Document Type Active Internet-Draft (individual)
Last updated 2018-09-01
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                                           W. Parad
Internet-Draft
Intended status: Standards Track                             I. Sowinski
Expires: March 5, 2019
                                                          R. Nowosielski
                                                       September 1, 2018

                     JSON Hypermedia Links Notation
                       draft-wparad-json-links-03

Abstract

   This document proposes the application/links+json media type for
   representing resources and their relations with hyperlinks.  It
   treats hypermedia links as first class object which can appear
   throughout a JSON document.

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 5, 2019.

Copyright Notice

   Copyright (c) 2018 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

Parad, et al.             Expires March 5, 2019                 [Page 1]
Internet-Draft                 Links+JSON                 September 2018

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Link-Relation . . . . . . . . . . . . . . . . . . . . . .   3
     2.2.  Links . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.3.  JSON Link Property Name . . . . . . . . . . . . . . . . .   3
     2.4.  JSON Link Property Value Object . . . . . . . . . . . . .   3
   3.  Reserved Words  . . . . . . . . . . . . . . . . . . . . . . .   4
   4.  Links Notation Document . . . . . . . . . . . . . . . . . . .   4
   5.  Link Resources  . . . . . . . . . . . . . . . . . . . . . . .   4
     5.1.  rel . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     5.2.  href  . . . . . . . . . . . . . . . . . . . . . . . . . .   5
     5.3.  templates . . . . . . . . . . . . . . . . . . . . . . . .   5
   6.  Discoverability . . . . . . . . . . . . . . . . . . . . . . .   5
   7.  Links Example . . . . . . . . . . . . . . . . . . . . . . . .   6
   8.  Backwards Compatibility . . . . . . . . . . . . . . . . . . .   7
   9.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   8
   10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   11. Security Considerations . . . . . . . . . . . . . . . . . . .   8
   12. References  . . . . . . . . . . . . . . . . . . . . . . . . .   8
     12.1.  Normative References . . . . . . . . . . . . . . . . . .   8
     12.2.  URIs . . . . . . . . . . . . . . . . . . . . . . . . . .   9
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   9

1.  Introduction

   This document introduces the media type "application/links+json" to
   support hypermedia linking inside JSON as defined by [RFC6838] and
   [RFC8259].  Hypermedia linking provides a dynamic way to navigate
   from one JSON representation to another JSON representation by
   following a URI in the form of a navigatable URL.  To ensure URLs are
   discoverable this standard creates the notion of a first class
   "links" JSON object name.  This property MUST adhere to the format in
   this document, and provides an a priori discoverability to
   representations which are of the media type "application/links+json".

   The "links" JSON object name becomes a reserved word and cannot be
   used without implying the semantics of this document.  The "links"
   can be found at multiple depths of a JSON representation and always
   implying the same meaning with regards to the context.  It is a
   dictionary which provides web linking [RFC8288] by defining the
   semanitcs of a linked representation.

Parad, et al.             Expires March 5, 2019                 [Page 2]
Internet-Draft                 Links+JSON                 September 2018
Show full document text