JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON
draft-wright-json-schema-hyperschema-01

Document Type Active Internet-Draft (individual)
Last updated 2017-04-16
Replaces draft-luff-json-hyper-schema
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                           A. Wright, Ed.
Internet-Draft
Intended status: Informational                           H. Andrews, Ed.
Expires: October 17, 2017                               Cloudflare, Inc.
                                                                 G. Luff
                                                          April 15, 2017

   JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON
                draft-wright-json-schema-hyperschema-01

Abstract

   JSON Schema is a JSON based format for defining the structure of JSON
   data.  This document specifies hyperlink- and hypermedia-related
   keywords of JSON Schema for annotating JSON documents with hyperlinks
   and instructions for processing and manipulating remote JSON
   resources through hypermedia environments like HTTP.

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 http://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 October 17, 2017.

Wright, et al.          Expires October 17, 2017                [Page 1]
Internet-Draft              JSON Hyper-Schema                 April 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
   (http://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.  Conventions and Terminology . . . . . . . . . . . . . . . . .   3
   3.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Interaction with validation . . . . . . . . . . . . . . .   5
   4.  Meta-schema . . . . . . . . . . . . . . . . . . . . . . . . .   5
   5.  Schema keywords . . . . . . . . . . . . . . . . . . . . . . .   5
     5.1.  base  . . . . . . . . . . . . . . . . . . . . . . . . . .   5
     5.2.  links . . . . . . . . . . . . . . . . . . . . . . . . . .   6
     5.3.  media . . . . . . . . . . . . . . . . . . . . . . . . . .   7
       5.3.1.  Properties of "media" . . . . . . . . . . . . . . . .   7
       5.3.2.  Example . . . . . . . . . . . . . . . . . . . . . . .   8
     5.4.  readOnly  . . . . . . . . . . . . . . . . . . . . . . . .   8
   6.  Link Description Object . . . . . . . . . . . . . . . . . . .   9
     6.1.  Links, operations, and data . . . . . . . . . . . . . . .   9
       6.1.1.  Resolving templated URIs  . . . . . . . . . . . . . .   9
       6.1.2.  Manipulating the target resource representation . . .  10
       6.1.3.  Submitting data for processing  . . . . . . . . . . .  10
     6.2.  href  . . . . . . . . . . . . . . . . . . . . . . . . . .  10
       6.2.1.  URI Templating  . . . . . . . . . . . . . . . . . . .  11
     6.3.  hrefSchema  . . . . . . . . . . . . . . . . . . . . . . .  12
     6.4.  rel . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
       6.4.1.  Security Considerations for "self" links  . . . . . .  16
     6.5.  title . . . . . . . . . . . . . . . . . . . . . . . . . .  17
     6.6.  targetSchema  . . . . . . . . . . . . . . . . . . . . . .  17
       6.6.1.  "targetSchema" and HTTP . . . . . . . . . . . . . . .  17
       6.6.2.  Security Considerations for "targetSchema"  . . . . .  17
     6.7.  mediaType . . . . . . . . . . . . . . . . . . . . . . . .  19
       6.7.1.  Security concerns for "mediaType" . . . . . . . . . .  20
Show full document text