JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON
draft-handrews-json-schema-hyperschema-00

Document Type Active Internet-Draft (individual)
Last updated 2017-11-20
Replaces draft-wright-json-schema-hyperschema
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)
Internet Engineering Task Force                          H. Andrews, Ed.
Internet-Draft                                          Cloudflare, Inc.
Intended status: Informational                            A. Wright, Ed.
Expires: May 23, 2018                                  November 19, 2017

   JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON
               draft-handrews-json-schema-hyperschema-00

Abstract

   JSON Schema is a JSON-based format for describing JSON data using
   various vocabularies.  This document specifies a vocabulary for
   annotating JSON documents with hyperlinks.  These hyperlinks include
   attributes describing how to manipulate and interact with remote
   resources through hypermedia environments such as HTTP, as well as
   determining whether the link is usable based on the instance value.
   The hyperlink serialization format described in this document is also
   usable independent of JSON Schema.

Note to Readers

   The issues list for this draft can be found at <https://github.com/
   json-schema-org/json-schema-spec/issues>.

   For additional information, see <http://json-schema.org/>.

   To provide feedback, use this issue tracker, the communication
   methods listed on the homepage, or email the document editors.

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 23, 2018.

Andrews & Wright          Expires May 23, 2018                  [Page 1]
Internet-Draft              JSON Hyper-Schema              November 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.  Notational Conventions  . . . . . . . . . . . . . . . . . . .   4
   3.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   5
     3.2.  Functionality . . . . . . . . . . . . . . . . . . . . . .   6
   4.  Meta-Schemas and Output Schema  . . . . . . . . . . . . . . .   7
   5.  Schema Keywords . . . . . . . . . . . . . . . . . . . . . . .   7
     5.1.  base  . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     5.2.  links . . . . . . . . . . . . . . . . . . . . . . . . . .   8
   6.  Link Description Object . . . . . . . . . . . . . . . . . . .   8
     6.1.  Link Context  . . . . . . . . . . . . . . . . . . . . . .   9
       6.1.1.  anchor  . . . . . . . . . . . . . . . . . . . . . . .   9
       6.1.2.  anchorPointer . . . . . . . . . . . . . . . . . . . .   9
     6.2.  Link Relation Type  . . . . . . . . . . . . . . . . . . .  10
       6.2.1.  rel . . . . . . . . . . . . . . . . . . . . . . . . .  10
       6.2.2.  "self" Links  . . . . . . . . . . . . . . . . . . . .  10
       6.2.3.  "collection" and "item" Links . . . . . . . . . . . .  11
       6.2.4.  Using Extension Relation Types  . . . . . . . . . . .  11
     6.3.  Link Target . . . . . . . . . . . . . . . . . . . . . . .  11
       6.3.1.  href  . . . . . . . . . . . . . . . . . . . . . . . .  12
     6.4.  Adjusting URI Template Resolution . . . . . . . . . . . .  12
       6.4.1.  templatePointers  . . . . . . . . . . . . . . . . . .  12
       6.4.2.  templateRequired  . . . . . . . . . . . . . . . . . .  12
     6.5.  Link Target Attributes  . . . . . . . . . . . . . . . . .  12
       6.5.1.  title . . . . . . . . . . . . . . . . . . . . . . . .  13
       6.5.2.  description . . . . . . . . . . . . . . . . . . . . .  13
       6.5.3.  targetMediaType . . . . . . . . . . . . . . . . . . .  13
       6.5.4.  targetSchema  . . . . . . . . . . . . . . . . . . . .  14
       6.5.5.  targetHints . . . . . . . . . . . . . . . . . . . . .  14
     6.6.  Link Input  . . . . . . . . . . . . . . . . . . . . . . .  15
Show full document text