idnits 2.17.1 draft-pbryan-zyp-json-ref-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 14, 2011) is 4547 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- ** Obsolete normative reference: RFC 4627 (Obsoleted by RFC 7158, RFC 7159) Summary: 1 error (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force P. Bryan, Ed. 3 Internet-Draft ForgeRock US, Inc. 4 Intended status: Informational K. Zyp 5 Expires: May 17, 2012 SitePen (USA) 6 November 14, 2011 8 JSON Reference 9 draft-pbryan-zyp-json-ref-00 11 Abstract 13 JSON Reference allows a JSON value to be referenced from within a 14 JSON document. 16 Status of this Memo 18 This Internet-Draft is submitted in full conformance with the 19 provisions of BCP 78 and BCP 79. 21 Internet-Drafts are working documents of the Internet Engineering 22 Task Force (IETF). Note that other groups may also distribute 23 working documents as Internet-Drafts. The list of current Internet- 24 Drafts is at http://datatracker.ietf.org/drafts/current/. 26 Internet-Drafts are draft documents valid for a maximum of six months 27 and may be updated, replaced, or obsoleted by other documents at any 28 time. It is inappropriate to use Internet-Drafts as reference 29 material or to cite them other than as "work in progress." 31 This Internet-Draft will expire on May 17, 2012. 33 Copyright Notice 35 Copyright (c) 2011 IETF Trust and the persons identified as the 36 document authors. All rights reserved. 38 This document is subject to BCP 78 and the IETF Trust's Legal 39 Provisions Relating to IETF Documents 40 (http://trustee.ietf.org/license-info) in effect on the date of 41 publication of this document. Please review these documents 42 carefully, as they describe your rights and restrictions with respect 43 to this document. Code Components extracted from this document must 44 include Simplified BSD License text as described in Section 4.e of 45 the Trust Legal Provisions and are provided without warranty as 46 described in the Simplified BSD License. 48 Table of Contents 50 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 51 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . 3 52 3. Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 4. Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . 3 54 5. Media Type . . . . . . . . . . . . . . . . . . . . . . . . . . 3 55 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 4 56 7. Security Considerations . . . . . . . . . . . . . . . . . . . . 4 57 8. Normative References . . . . . . . . . . . . . . . . . . . . . 4 58 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . . 4 59 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 4 61 1. Introduction 63 This specification defines a JSON [RFC4627] structure for referencing 64 a specific JSON value within a JSON document. This provides a basis 65 for transclusion in JSON: the use of a target resource as an 66 effective substitute for the reference. 68 2. Conventions 70 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 71 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 72 document are to be interpreted as described in [RFC2119]. 74 3. Syntax 76 A JSON Reference is a JSON object containing a single member "$ref", 77 whose value identifies another JSON value via a URI [RFC3986]. 78 Example: 80 { "$ref": "http://example.com/example.json#/foo/bar" } 82 4. Resolution 84 Resolution of a JSON Reference object SHOULD yield the referenced 85 JSON value. 87 If the URI contained in the JSON Reference value is a relative URI, 88 then the base URI resolution MUST be calculated according to 89 [RFC3986], section 5.2. Resolution is performed relative to the 90 referring document. 92 If a URI contains a fragment identifier, then the fragment should be 93 resolved per the fragment resolution mechansim of the referrant 94 document. If the representation of the referrant document is JSON, 95 then the fragment identifier SHOULD be interpreted as a [JSON 96 Pointer]. 98 5. Media Type 100 Documents that use JSON Reference SHOULD include a media type 101 parameter: application/json; profile=http://json-schema.org/json-ref 102 or refer to a schema that extends http://json-schema.org/json-ref. 104 6. IANA Considerations 106 This draft includes no request to IANA. 108 7. Security Considerations 110 A JSON Reference is not guaranteed to resolve to a JSON value. 111 Implementations of this specification should be aware of this and 112 take appropriate precautions. 114 8. Normative References 116 [JSON Pointer] 117 Bryan, P. and K. Zyp, "JSON Pointer", October 2011, . 120 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 121 Requirement Levels", BCP 14, RFC 2119, March 1997. 123 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 124 Resource Identifier (URI): Generic Syntax", STD 66, 125 RFC 3986, January 2005. 127 [RFC4627] Crockford, D., "The application/json Media Type for 128 JavaScript Object Notation (JSON)", RFC 4627, July 2006. 130 Appendix A. Examples 132 TBD. 134 Authors' Addresses 136 Paul C. Bryan (editor) 137 ForgeRock US, Inc. 138 201 NE Park Plaza Drive Suite 196 139 Vancouver, WA 98684 140 USA 142 Phone: +1 604 783 1481 143 Email: paul.bryan@forgerock.com 144 Kris Zyp 145 SitePen (USA) 146 530 Lytton Avenue 147 Palo Alto, CA 94301 148 USA 150 Phone: +1 650 968 8787 151 Email: kris@sitepen.com