One document matched: draft-pbryan-zyp-json-ref-00.xml


<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
<!ENTITY RFC2616 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2616.xml">
<!ENTITY RFC4627 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4627.xml">
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc strict="yes" ?>
<?rfc toc="yes"?>
<?rfc tocdepth="4"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes" ?>
<?rfc compact="yes" ?>
<?rfc subcompact="no" ?>
<rfc category="info" docName="draft-pbryan-zyp-json-ref-00" ipr="trust200902">

    <front>
        <title>JSON Reference</title>
        <author fullname="Paul C. Bryan" initials="P." surname="Bryan" role="editor">
            <organization>ForgeRock US, Inc.</organization>
            <address>
                <postal>
                    <street>201 NE Park Plaza Drive Suite 196</street>
                    <city>Vancouver</city>
                    <region>WA</region>
                    <code>98684</code>
                    <country>USA</country>
                </postal>
                <phone>+1 604 783 1481</phone>
                <email>paul.bryan@forgerock.com</email>
            </address>
        </author>
        <author fullname="Kris Zyp" initials="K." surname="Zyp">
            <organization>SitePen (USA)</organization>
            <address>
                <postal>
                    <street>530 Lytton Avenue</street>
                    <city>Palo Alto</city>
                    <region>CA</region>
                    <code>94301</code>
                    <country>USA</country>
                </postal>
                <phone>+1 650 968 8787</phone>
                <email>kris@sitepen.com</email>
            </address>
        </author>
        <date year="2011" />
        <area>General</area>
        <workgroup>Internet Engineering Task Force</workgroup>
        <keyword>json</keyword>
        <abstract>
            <t>JSON Reference allows a JSON value to be referenced from within a JSON
            document.</t>
        </abstract>
    </front>

    <middle>
        <section title="Introduction">
            <t>This specification defines a <xref target="RFC4627">JSON</xref> structure for
            referencing a specific JSON value within a JSON document. This provides a basis
            for transclusion in JSON: the use of a target resource as an effective
            substitute for the reference.</t>
        </section>
        <section title="Conventions">
            <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
             "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
             interpreted as described in <xref target="RFC2119"/>.</t>
        </section>
        <section title="Syntax">
            <t><figure>
            <preamble>A JSON Reference is a JSON object containing a single member "$ref",
            whose value identifies another JSON value via a
            <xref target="RFC3986">URI</xref>. Example:</preamble>
            <artwork><![CDATA[
{ "$ref": "http://example.com/example.json#/foo/bar" }
]]>         </artwork></figure></t>
        </section>
        <section title="Resolution">
            <t>Resolution of a JSON Reference object SHOULD yield the referenced JSON
            value.</t> 
            <t>If the URI contained in the JSON Reference value is a relative URI, then
            the base URI resolution MUST be calculated according to <xref target="RFC3986"/>,
            section 5.2. Resolution is performed relative to the referring document.</t>
            <t>If a URI contains a fragment identifier, then the fragment should be resolved
            per the fragment resolution mechansim of the referrant document. If the
            representation of the referrant document is JSON, then the fragment identifier
            SHOULD be interpreted as a <xref target="JSON Pointer"/>.</t>
        </section>
        <section title="Media Type">
            <t>Documents that use JSON Reference SHOULD include a media type parameter:
             application/json; profile=http://json-schema.org/json-ref or refer to a schema
             that extends http://json-schema.org/json-ref.</t>
        </section>
        <section anchor="IANA" title="IANA Considerations">
            <t>This draft includes no request to IANA.</t>
        </section>
        <section anchor="Security" title="Security Considerations">
            <t>A JSON Reference is not guaranteed to resolve to a JSON value. Implementations
            of this specification should be aware of this and take appropriate precautions.</t>
        </section>
    </middle>

    <back>
        <references title="Normative References">
            &RFC2119;
            &RFC3986;
            &RFC4627;
            <reference anchor="JSON Pointer" target="http://tools.ietf.org/html/draft-pbryan-zyp-json-pointer-02">
                <front>
                    <title>JSON Pointer</title>
                    <author initials="P." surname="Bryan">
                        <organization>ForgeRock US, Inc.</organization>
                    </author>
                    <author initials="K." surname="Zyp">
                        <organization>SitePen (USA)</organization>
                    </author>
                    <date year="2011" month="October" />
                </front>
            </reference>
        </references>

        <section title="Examples">
            <t>TBD.</t>
        </section>
        
    </back>

</rfc>

PAFTECH AB 2003-20262026-04-24 01:18:42