Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 1015 lines (949 sloc) 47.752 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfc4627 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4627.xml">
<!ENTITY rfc3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
<!ENTITY rfc2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY rfc4287 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4287.xml">
<!ENTITY rfc2616 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2616.xml">
<!ENTITY rfc3339 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3339.xml">
<!ENTITY rfc2045 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2045.xml">
<!ENTITY rfc5226 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5226.xml">
<!ENTITY rfc2396 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2396.xml">
<!ENTITY iddiscovery SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.hammer-discovery.xml">
<!ENTITY uritemplate SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.gregorio-uritemplate.xml">
<!ENTITY linkheader SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.nottingham-http-link-header.xml">
<!ENTITY html401 SYSTEM "http://xml.resource.org/public/rfc/bibxml4/reference.W3C.REC-html401-19991224.xml">
<!ENTITY css21 SYSTEM "http://xml.resource.org/public/rfc/bibxml4/reference.W3C.CR-CSS21-20070719.xml">
]>
<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<?rfc strict="no"?>
<?rfc rfcedstyle="yes"?>
<rfc category="info" docName="draft-zyp-json-schema-03" ipr="trust200902">
  <front>

    <title abbrev="JSON Schema Media Type">A JSON Media Type for Describing the Structure and Meaning of JSON Documents</title>

    <author fullname="Kris Zyp" initials="K" role="editor"
            surname="Zyp">
      <organization>SitePen (USA)</organization>

      <address>
        <postal>
          <street>530 Lytton Avenue</street>

          <city>Palo Alto, CA 94301</city>

          <country>USA</country>
        </postal>

        <phone>+1 650 968 8787</phone>

        <email>kris@sitepen.com</email>
      </address>
    </author>
    
    <author fullname="Gary Court" initials="G" surname="Court">
      <address>
        <postal>
          <city>Calgary, AB</city>
          <country>Canada</country>
        </postal>
        <email>gary.court@gmail.com</email>
      </address>
    </author>

    <date year="2010" />

    <workgroup>Internet Engineering Task Force</workgroup>

    <keyword>JSON</keyword>
    <keyword>Schema</keyword>
    <keyword>JavaScript</keyword>
    <keyword>Object</keyword>
    <keyword>Notation</keyword>
    <keyword>Hyper Schema</keyword>
    <keyword>Hypermedia</keyword>

    <!--[TODO] add additional keywords here for IETF website search engine -->

    <abstract>
      <t>JSON (JavaScript Object Notation) Schema defines the media type "application/schema+json",
      a JSON based format for defining
      the structure of JSON data. JSON Schema provides a contract for what JSON
      data is required for a given application and how to interact with it. JSON
      Schema is intended to define validation, documentation, hyperlink
      navigation, and interaction control of JSON data. </t>

    </abstract>

  </front>

  <middle>
    <section title="Introduction">
      <t>JSON (JavaScript Object Notation) Schema is a JSON media type for defining
      the structure of JSON data. JSON Schema provides a contract for what JSON
      data is required for a given application and how to interact with it. JSON
      Schema is intended to define validation, documentation, hyperlink
      navigation, and interaction control of JSON data. </t>
    </section>


    <section title="Conventions">
      <t><!-- The text in this section has been copied from the official boilerplate,
and should not be modified.-->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'>RFC 2119</xref>.</t>
    </section>

    <!-- ********************************************* -->

    <section title="Overview">
      <t>JSON Schema defines the media type "application/schema+json" for
      describing the structure of other
      JSON documents. JSON Schema is JSON-based and includes facilities
      for describing the structure of JSON documents in terms of
      allowable values, descriptions, and interpreting relations with other resources.</t>
      
      <t>JSON Schema format is organized into several separate definitions. The first
      definition is the core schema specification. This definition is primary
      concerned with describing a JSON structure and specifying valid elements
      in the structure. The second definition is the Hyper Schema specification
      which is intended define elements in a structure that can be interpreted as
      hyperlinks.
      Hyper Schema builds on JSON Schema to describe the hyperlink structure of
      other JSON documents and elements of interaction. This allows user agents to be able to successfully navigate
      JSON documents based on their schemas.</t>
      
      <t>
      Cumulatively JSON Schema acts as a meta-document that can be used to define the required type and constraints on
      property values, as well as define the meaning of the property values
      for the purpose of describing a resource and determining hyperlinks
      within the representation. </t>

      <figure>
      <preamble>An example JSON Schema that describes products might look like:</preamble>
        <artwork><![CDATA[
{
"name":"Product",
"properties":{
"id":{
"type":"number",
"description":"Product identifier",
"required":true
},
"name":{
"description":"Name of the product",
"type":"string",
"required":true
},
"price":{
"required":true,
"type": "number",
"minimum":0,
"required":true
},
"tags":{
"type":"array",
"items":{
"type":"string"
}
}
},
"links":[
{
"rel":"full",
"href":"{id}"
},
{
"rel":"comments",
"href":"comments/?id={id}"
}
]
}
]]></artwork>
<postamble>
This schema defines the properties of the instance JSON documents,
the required properties (id, name, and price), as well as an optional
property (tags). This also defines the link relations of the instance
JSON documents.
</postamble>
</figure>
    <section title="Terminology">
      <t>For this specification, <spanx style="strong">schema</spanx> will be used to denote a JSON Schema
      definition, and an <spanx style="strong">instance</spanx> refers to a JSON value that the schema
      will be describing and validating.</t>

      </section>
<section title="Design Considerations">
<t>
The JSON Schema media type does not attempt to dictate the structure of JSON
representations that contain data, but rather provides a separate format
for flexibly communicating how a JSON representation should be
interpreted and validated, such that user agents can properly understand
acceptable structures and extrapolate hyperlink information
with the JSON document. It is acknowledged that JSON documents come
in a variety of structures, and JSON is unique in that the structure
of stored data structures often prescribes a non-ambiguous definite
JSON representation. Attempting to force a specific structure is generally
not viable, and therefore JSON Schema allows for a great flexibility
in the structure of the JSON data that it describes.
</t>
<t>This specification is protocol agnostic.
The underlying protocol (such as HTTP) should sufficiently define the
semantics of the client-server interface, the retrieval of resource
representations linked to by JSON representations, and modification of
those resources. The goal of this
format is to sufficiently describe JSON structures such that one can
utilize existing information available in existing JSON
representations from a large variety of services that leverage a representational state transfer
architecture using existing protocols.
</t>
</section>
    </section>
    
<section title="Schema/Instance Association">
<t>
JSON Schema instances are correlated to their schema by the "describedby"
relation, where the schema is defined to be the target of the relation.
Instance representations may be of the "application/json" media type or
any other subtype. Consequently, dictating how an instance
representation should specify the relation to the schema is beyond the normative scope
of this document (since this document specifically defines the JSON
Schema media type, and no other), but it is recommended that instances
specify their schema so that user agents can interpret the instance
representation and messages may retain the self-descriptive
characteristic, avoiding the need for out-of-band information about
instance data. Two approaches are recommended for declaring the
relation to the schema that describes the meaning of a JSON instance's (or collection
of instances) structure. A MIME type parameter named
"profile" or a relation of "describedby" (which could be defined by a Link header) may be used:
      <figure>
        <artwork><![CDATA[
Content-Type: application/my-media-type+json;
profile=http://json.com/my-hyper-schema
]]></artwork></figure>
or if the content is being transferred by a protocol (such as HTTP) that
provides headers, a Link header can be used:
      <figure>
        <artwork><![CDATA[
Link: <http://json.com/my-hyper-schema>; rel="describedby"
]]></artwork></figure>
Instances MAY specify multiple schemas, to indicate all the schemas that
are applicable to the data, and the data SHOULD be valid by all the schemas.
The instance data MAY have multiple schemas
that it is defined by (the instance data SHOULD be valid for those schemas).
Or if the document is a collection of instances, the collection MAY contain
instances from different schemas. When collections contain heterogeneous
instances, the "pathStart" attribute MAY be specified in the
schema to disambiguate which schema should be applied for each item in the
collection. However, ultimately, the mechanism for referencing a schema is up to the
media type of the instance documents (if they choose to specify that schemas
can be referenced).
</t>
<section title="Self-Descriptive Schema">
<t>
JSON Schemas can themselves be described using JSON Schemas.
A self-describing JSON Schema for the core JSON Schema can
be found at <eref target="http://json-schema.org/schema">http://json-schema.org/schema</eref> for the latest version or
<eref target="http://json-schema.org/draft-03/schema">http://json-schema.org/draft-03/schema</eref> for the draft-03 version. The hyper schema
self-description can be found at <eref target="http://json-schema.org/hyper-schema">http://json-schema.org/hyper-schema</eref>
or <eref target="http://json-schema.org/draft-03/hyper-schema">http://json-schema.org/draft-03/hyper-schema</eref>. All schemas
used within a protocol with media type definitions
SHOULD include a MIME parameter that refers to the self-descriptive
hyper schema or another schema that extends this hyper schema:
      <figure>
        <artwork><![CDATA[
Content-Type: application/json;
profile=http://json-schema.org/draft-03/hyper-schema
]]></artwork></figure>
</t>
</section>
</section>

      <section title="Core Schema Definition">
        <t>A JSON Schema is a JSON Object that defines various attributes
        (including usage and valid values) of a JSON value. JSON
        Schema has recursive capabilities; there are a number of elements
        in the structure that allow for nested JSON Schemas.</t>

<t>An example JSON Schema definition could look like:</t>
      <figure>
        <artwork><![CDATA[
{
"description":"A person",
"type":"object",

"properties":{
"name":{"type":"string"},
"age" :{
"type":"integer",
"maximum":125
}
}
}
]]></artwork>
</figure>

<t>A JSON Schema object may have any of the following properties, called schema
attributes (all attributes are optional):
      </t>

<section title="type">
<t>
This attribute defines what the primitive type or the schema of the instance MUST be in order to validate.
This attribute can take one of two forms:

<list style="hanging">
<t hangText="Simple Types">A string indicating a primitive or simple type. The following are acceptable string values:

<list style="hanging">
<t hangText="string">Value MUST be a string.</t>
<t hangText="number">Value MUST be a number, floating point numbers are allowed. </t>
<t hangText="integer">Value MUST be an integer, no floating point numbers are allowed. This is a subset of the number type.</t>
<t hangText="boolean">Value MUST be a boolean. </t>
<t hangText="object">Value MUST be an object.</t>
<t hangText="array">Value MUST be an array.</t>
<t hangText="null">Value MUST be null. Note this is mainly for purpose of being able use union types to define nullability. If this type is not
included in a union, null values are not allowed (the primitives listed above do not allow nulls on their own).</t>
<t hangText="any">Value MAY be of any type including null.
</t>
</list>
If the property is not defined or is not in this list, then any type of value is acceptable. Other type values MAY be used for custom purposes, but minimal validators of the specification implementation can allow any instance value on unknown type values.
</t>
<t hangText="Union Types">An array of two or more simple type definitions. Each item in the array MUST be a simple type definition or a schema. The instance value is valid if it is of the same type as one of the simple type definitions, or valid by one of the schemas, in the array.
</t>
</list>
</t>
      <figure>
        <preamble>For example, a schema that defines if an instance can be a string or a number would be:</preamble>
        <artwork><![CDATA[
{"type":["string","number"]}
]]></artwork>
      </figure>
</section>
<section title="properties" anchor="properties">
<t>This attribute is an object with property definitions that define the valid values of instance object property values. When the instance value is an object, the property values of the instance object MUST conform to the property definitions in this object. In this object, each property definition's value MUST be a schema, and the property's name MUST be the name of the instance property that it defines. The instance property value MUST be valid according to the schema from the property definition. Properties are considered unordered, the order of the instance properties MAY be in any order.</t>
</section>
<section title="patternProperties">
<t>This attribute is an object that defines the schema for a set of property names of an object instance. The name of each property of this attribute's object is a regular expression pattern in the ECMA 262/Perl 5 format, while the value is a schema. If the pattern matches the name of a property on the instance object, the value of the instance's property MUST be valid against the pattern name's schema value.</t>
</section>
<section title="additionalProperties" anchor="additionalProperties">
<t>This attribute defines a schema for all properties that are not explicitly defined in an object type definition. If specified, the value MUST be a schema or a boolean. If false is provided, no additional properties are allowed beyond the properties defined in the schema. The default value is an empty schema which allows any value for additional properties.</t>
</section>
<section title="items">
<t>This attribute defines the allowed items in an instance array, and MUST be a schema or an array of schemas. The default value is an empty schema which allows any value for items in the instance array.</t>
<t>When this attribute value is a schema and the instance value is an array, then all the items in the array MUST be valid according to the schema.</t>
<t>When this attribute value is an array of schemas and the instance value is an array, each position in the instance array MUST conform to the schema in the corresponding position for this array. This called tuple typing. When tuple typing is used, additional items are allowed, disallowed, or constrained by the <xref target="additionalItems">"additionalItems"</xref> attribute using the same rules as <xref target="additionalProperties">"additionalProperties"</xref> for objects.</t>
</section>
<section title="additionalItems" anchor="additionalItems">
<t>This provides a definition for additional items in an array instance when tuple definitions of the items is provided. This can be false to indicate additional items in the array are not allowed, or it can be a schema that defines the schema of the additional items.</t>
</section>
<section title="required">
<t>This attribute indicates if the instance must have a value, and not be undefined. This is false by default, making the instance optional.</t>
</section>
<section title="dependencies">
<t>This attribute is an object that defines the requirements of a property on an instance object. If an object instance has a property with the same name as a property in this attribute's object, then the instance must be valid against the attribute's property value (hereafter referred to as the "dependency value").</t>
<t>
The dependency value can take one of two forms:
<list style="hanging">
<t hangText="Simple Dependency">If the dependency value is a string, then the instance object MUST have a property with the same name as the dependency value. If the dependency value is an array of strings, then the instance object MUST have a property with the same name as each string in the dependency value's array.</t>
<t hangText="Schema Dependency">If the dependency value is a schema, then the instance object MUST be valid against the schema.</t>
</list>
</t>
</section>
<section title="minimum">
<t>This attribute defines the minimum value of the instance property when the type of the instance value is a number.</t>
</section>
<section title="maximum">
<t>This attribute defines the maximum value of the instance property when the type of the instance value is a number.</t>
</section>
<section title="exclusiveMinimum">
<t>This attribute indicates if the value of the instance (if the instance is a number) can not equal the number defined by the "minimum" attribute. This is false by default, meaning the instance value can be greater then or equal to the minimum value.</t>
</section>
<section title="exclusiveMaximum">
<t>This attribute indicates if the value of the instance (if the instance is a number) can not equal the number defined by the "maximum" attribute. This is false by default, meaning the instance value can be less then or equal to the maximum value.</t>
</section>
<section title="minItems">
<t>This attribute defines the minimum number of values in an array when the array is the instance value.</t>
</section>
<section title="maxItems">
<t>This attribute defines the maximum number of values in an array when the array is the instance value.</t>
</section>
<section title="uniqueItems" anchor="uniqueItems">
<t>This attribute indicates that all items in an array instance MUST be unique (contains no two identical values).</t>
<t>Two instance are consider equal if they are both of the same type and:
<list>
<t>are null; or</t>
<t>are booleans/numbers/strings and have the same value; or</t>
<t>are arrays, contains the same number of items, and each item in the array is equal to the corresponding item in the other array; or</t>
<t>are objects, contains the same property names, and each property in the object is equal to the corresponding property in the other object.</t>
</list>
</t>
</section>
<section title="pattern">
<t>When the instance value is a string, this provides a regular expression that a string instance MUST match in order to be valid. Regular expressions SHOULD follow the regular expression specification from ECMA 262/Perl 5</t></section>
<section title="minLength">
<t>When the instance value is a string, this defines the minimum length of the string.</t>
</section>
<section title="maxLength">
<t>When the instance value is a string, this defines the maximum length of the string.</t>
</section>
<section title="enum">
<t>This provides an enumeration of all possible values that are valid for the instance property. This MUST be an array, and each item in the array represents a possible value for the instance value. If this attribute is defined, the instance value MUST be one of the values in the array in order for the schema to be valid. Comparison of enum values uses the same algorithm as defined in <xref target="uniqueItems">"uniqueItems"</xref>.</t>
</section>
<section title="default">
<t>This attribute defines the default value of the instance when the instance is undefined.</t>
</section>
<section title="title">
<t>This attribute is a string that provides a short description of the instance property.</t>
</section>
<section title="description">
<t>This attribute is a string that provides a full description of the of purpose the instance property.</t>
</section>

<section title="format"><t>This property defines the type of data, content type, or microformat to be expected in the instance property values. A format attribute MAY be one of the values listed below, and if so, SHOULD adhere to the semantics describing for the format. A format SHOULD only be used to give meaning to primitive types (string, integer, number, or boolean). Validators MAY (but are not required to) validate that the instance values conform to a format. The following formats are predefined:</t>
<t>
<list style="hanging">
<t hangText="date-time">This SHOULD be a date in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time. This is the recommended form of date/timestamp.
</t><t hangText="date">This SHOULD be a date in the format of YYYY-MM-DD. It is recommended that you use the "date-time" format instead of "date" unless you need to transfer only the date part.
</t><t hangText="time">This SHOULD be a time in the format of hh:mm:ss. It is recommended that you use the "date-time" format instead of "time" unless you need to transfer only the time part.
</t><t hangText="utc-millisec">This SHOULD be the difference, measured in milliseconds, between the specified time and midnight, 00:00 of January 1, 1970 UTC. The value SHOULD be a number (integer or float).
</t><t hangText="regex">A regular expression, following the regular expression specification from ECMA 262/Perl 5.
</t><t hangText="color">This is a CSS color (like "#FF0000" or "red"), based on <xref target='W3C.CR-CSS21-20070719'>CSS 2.1</xref>.
</t><t hangText="style">This is a CSS style definition (like "color: red; background-color:#FFF"), based on <xref target='W3C.CR-CSS21-20070719'>CSS 2.1</xref>.
</t><t hangText="phone">This SHOULD be a phone number (format MAY follow E.123).
</t><t hangText="uri">This value SHOULD be a URI..
</t><t hangText="email">This SHOULD be an email address.
</t><t hangText="ip-address">This SHOULD be an ip version 4 address.
</t><t hangText="ipv6">This SHOULD be an ip version 6 address.
</t><t hangText="host-name">This SHOULD be a host-name.</t>
</list>
</t>
<t>Additional custom formats MAY be created. These custom formats MAY be expressed as an URI, and this URI MAY reference a schema of that format.</t>
</section>
<section title="divisibleBy">
<t>This attribute defines what value the number instance must be divisible by with no remainder (the result of the division must be an integer.) The value of this attribute SHOULD NOT be 0.</t>
</section>
<section title="disallow">
<t>This attribute takes the same values as the "type" attribute, however if the instance matches the type or if this value is an array and the instance matches any type or schema in the array, then this instance is not valid.</t>
</section>
<section title="extends">
<t>The value of this property MUST be another schema which will provide a base schema which the current schema will inherit from. The inheritance rules are such that any instance that is valid according to the current schema MUST be valid according to the referenced schema. This MAY also be an array, in which case, the instance MUST be valid for all the schemas in the array. A schema that extends another schema MAY define additional attributes, constrain existing attributes, or add other constraints.</t>
<t>Conceptually, the behavior of extends can be seen as validating an
instance against all constraints in the extending schema as well as
the extended schema(s). More optimized implementations that merge
schemas are possible, but are not required. An example of using "extends":
      <figure>
        <artwork><![CDATA[
{
"description":"An adult",
"properties":{"age":{"minimum":21}},
"extends":{"$ref":"person"}
}
]]></artwork></figure>
      <figure>
        <artwork><![CDATA[
{
"description":"Extended schema",
"properties":{"deprecated":{"type":"boolean"}},
"extends":{"$ref":"http://json-schema.org/draft-03/schema"}
}
]]></artwork></figure>


</t>
</section>
<section title="id">
<t>
This attribute defines the current URI of this schema (this attribute is
effectively a "self" link). This URI MAY be relative or absolute. If
the URI is relative it is resolved against the current URI of the parent
schema it is contained in. If this schema is not contained in any
parent schema, the current URI of the parent schema is held to be the
URI under which this schema was addressed. If id is missing, the current URI of a schema is
defined to be that of the parent schema. The current URI of the schema
is also used to construct relative references such as for $ref.</t>
</section>
<section title="$ref">
<t>
This attribute defines a URI of a schema that contains the full representation of this schema.
When a validator encounters this attribute, it SHOULD replace the current schema with the schema referenced by the value's URI (if known and available) and re-validate the instance.
This URI MAY be relative or absolute, and relative URIs SHOULD be resolved against the URI of the current schema.
</t>
</section>
<section title="$schema">
<t>
This attribute defines a URI of a JSON Schema that is the schema of the current schema.
When this attribute is defined, a validator SHOULD use the schema referenced by the value's URI (if known and available) when resolving <xref target="hyper-schema">Hyper Schema</xref> <xref target="links">links</xref>.
</t>
<t>
A validator MAY use this attribute's value to determine which version of JSON Schema the current schema is written in, and provide the appropriate validation features and behavior.
Therefore, it is RECOMMENDED that all schema authors include this attribute in their schemas to prevent conflicts with future JSON Schema specification changes.
</t>
</section>
    </section>
<section title="Hyper Schema" anchor="hyper-schema">
      <t>The following attributes are specified in addition to those
attributes that already provided by the core schema with the specific
purpose of informing user agents of relations between resources based
on JSON data. Just as with JSON
schema attributes, all the attributes in hyper schemas are optional.
Therefore, an empty object is a valid (non-informative) schema, and
essentially describes plain JSON (no constraints on the structures).
Addition of attributes provides additive information for user agents.</t>

<section title="links" anchor="links">
<t>
The value of the links property MUST be an array, where each item
in the array is a link description object which describes the link
relations of the instances.
</t>
<section title="Link Description Object">
<t>
A link description object is used to describe link relations. In
the context of a schema, it defines the link relations of the
instances of the schema, and can be parameterized by the instance
values. The link description format can be used on its own in
regular (non-schema documents), and use of this format can
be declared by referencing the normative link description
schema as the the schema for the data structure that uses the
links. The URI of the normative link description schema is:
<eref target="http://json-schema.org/links">http://json-schema.org/links</eref> (latest version) or
<eref target="http://json-schema.org/draft-03/links">http://json-schema.org/draft-03/links</eref> (draft-03 version).
</t>
<section title="href">
    <t>
    The value of the "href" link description property
indicates the target URI of the related resource. The value
of the instance property SHOULD be resolved as a URI-Reference per <xref target='RFC3986'>RFC 3986</xref>
and MAY be a relative URI. The base URI to be used for relative resolution
SHOULD be the URI used to retrieve the instance object (not the schema)
when used within a schema. Also, when links are used within a schema, the URI
SHOULD be parametrized by the property values of the instance
object, if property values exist for the corresponding variables
in the template (otherwise they MAY be provided from alternate sources, like user input).
</t>
<t>
Instance property values SHOULD be substituted into the URIs where
matching braces ('{', '}') are found surrounding zero or more characters,
creating an expanded URI. Instance property value substitutions are resolved
by using the text between the braces to denote the property name
from the instance to get the value to substitute. For example,
if an href value is defined:
      <figure>
        <artwork><![CDATA[
http://somesite.com/{id}
]]></artwork>
</figure>
Then it would be resolved by replace the value of the "id" property value from
the instance object. If the value of the "id" property was "45", the expanded
URI would be:
      <figure>
        <artwork><![CDATA[
http://somesite.com/45
]]></artwork>
</figure>
If matching braces are found with the string "@" (no quotes) between the braces, then the
actual instance value SHOULD be used to replace the braces, rather than a property value.
This should only be used in situations where the instance is a scalar (string,
boolean, or number), and not for objects or arrays.
</t>
</section>
<section title="rel">
<t>
The value of the "rel" property indicates the name of the
relation to the target resource. The relation to the target SHOULD be interpreted as specifically from the instance object that the schema (or sub-schema) applies to, not just the top level resource that contains the object within its hierarchy. If a resource JSON representation contains a sub object with a property interpreted as a link, that sub-object holds the relation with the target. A relation to target from the top level resource MUST be indicated with the schema describing the top level JSON representation.
</t>
<t>
Relationship definitions SHOULD NOT be media type dependent, and users are encouraged to utilize existing accepted relation definitions, including those in existing relation registries (see <xref target='RFC4287'>RFC 4287</xref>). However, we define these relations here for clarity of normative interpretation within the context of JSON hyper schema defined relations:
<list style="hanging">
<t hangText="self">
If the relation value is "self", when this property is encountered in
the instance object, the object represents a resource and the instance object is
treated as a full representation of the target resource identified by
the specified URI.
</t>
<t hangText="full">
This indicates that the target of the link is the full representation for the instance object. The object that contains this link possibly may not be the full representation.
</t>
<t hangText="describedby">
This indicates the target of the link is the schema for the instance object. This MAY be used to specifically denote the schemas of objects within a JSON object hierarchy, facilitating polymorphic type data structures.
</t>
<t hangText="root">This relation indicates that the target of the link
SHOULD be treated as the root or the body of the representation for the
purposes of user agent interaction or fragment resolution. All other
properties of the instance objects can be regarded as meta-data
descriptions for the data.
</t>
</list>
</t>
<t>
The following relations are applicable for schemas (the schema as the "from" resource in the relation):
<list style="hanging">
<t hangText="instances">
This indicates the target resource that represents collection of instances of a schema.
</t>
<t hangText="create">
This indicates a target to use for creating new instances of a schema. This link definition SHOULD be a submission link with a non-safe method (like POST).
</t>
</list>
</t>
<t>
For example, if a schema is defined:
      <figure>
        <artwork><![CDATA[
{
"links": [
{
"rel": "self"
"href": "{id}"
},
{
"rel": "up"
"href": "{upId}"
},
{
"rel": "children"
"href": "?upId={id}"
}
]
}
]]></artwork>
</figure>
And if a collection of instance resource's JSON representation was
retrieved:
    <figure>
        <artwork><![CDATA[
GET /Resource/

[
{
"id": "thing",
"upId": "parent"
},
{
"id": "thing2",
"upId": "parent"
}
]
]]></artwork>
</figure>

This would indicate that for the first item in the collection, its own
(self) URI would resolve to "/Resource/thing" and the first item's "up"
relation SHOULD be resolved to the resource at "/Resource/parent".
The "children" collection would be located at "/Resource/?upId=thing".
</t>
</section>
<section title="targetSchema">
<t>This property value is a schema that defines the expected
structure of the JSON representation of the target of the link.</t>
</section>
<section title="Submission Link Properties">
<t>
The following properties also apply to link definition objects, and
provide functionality analogous to HTML forms, in providing a
means for submitting extra (often user supplied) information to send to a server.
</t>
<section title="method">
<t>

This attribute defines which method can be used to access the target resource.
In an HTTP environment, this would be "GET" or "POST" (other HTTP methods
such as "PUT" and "DELETE" have semantics that are clearly implied by
accessed resources, and do not need to be defined here).
This defaults to "GET".
</t>
</section>

<section title="enctype">
<t>
If present, this property indicates a query media type format that the server
supports for querying or posting to the collection of instances at the target
resource. The query can be
suffixed to the target URI to query the collection with
property-based constraints on the resources that SHOULD be returned from
the server or used to post data to the resource (depending on the method).
For example, with the following schema:
    <figure>
        <artwork><![CDATA[
{
"links":[
{
"enctype":"application/x-www-form-urlencoded",
"method":"GET",
"href":"/Product/",
"properties":{
"name":{"description":"name of the product"}
}
}
]
}
]]></artwork>
</figure>
This indicates that the client can query the server for instances that
have a specific name:
    <figure>
        <artwork><![CDATA[
/Product/?name=Slinky
]]></artwork>
</figure>

If no enctype or method is specified, only the single URI specified by
the href property is defined. If the method is POST, "application/json" is
the default media type.
</t>
</section>
<section title="schema">
<t>
This attribute contains a schema which defines the acceptable structure of the submitted
request (for a GET request, this schema would define the properties for the query string
and for a POST request, this would define the body).
</t>
</section>
</section>
</section>

</section>
    <section title="fragmentResolution">
    <t>This property indicates the fragment resolution protocol to use for
resolving fragment identifiers in URIs within the instance
representations. This applies to the instance object URIs and all
children of the instance object's URIs. The default fragment resolution
protocol is "slash-delimited", which is defined below. Other fragment
resolution protocols MAY be used, but are not defined in this
document.

</t>
<t>
The fragment identifier is based on <xref target='RFC2396'>RFC 2396, Sec 5</xref>, and defines the
mechanism for resolving references to entities within a document.
</t>
<section title="slash-delimited fragment resolution">
<t>With the slash-delimited fragment resolution protocol, the fragment
identifier is interpreted as a series of property reference tokens that start with and
are delimited by the "/" character (\x2F). Each property reference token
is a series of unreserved or escaped URI characters. Each property
reference token SHOULD be interpreted, starting from the beginning of
the fragment identifier, as a path reference in the target JSON
structure. The final target value of the fragment can be determined by
starting with the root of the JSON structure from the representation of
the resource identified by the pre-fragment URI. If the target is a JSON
object, then the new target is the value of the property with the name
identified by the next property reference token in the fragment. If the
target is a JSON array, then the target is determined by finding the
item in array the array with the index defined by the next property
reference token (which MUST be a number). The target is successively
updated for each property reference token, until the entire fragment has
been traversed.
</t>
<t>
Property names SHOULD be URI-encoded. In particular, any "/" in a
property name MUST be encoded to avoid being interpreted as a property
delimiter.
</t>
<t>
For example, for the following JSON representation:
    <figure>
        <artwork><![CDATA[
{
"foo":{
"anArray":[
{"prop":44}
],
"another prop":{
"baz":"A string"
}
}
}
]]></artwork>
</figure>
The following fragment identifiers would be resolved:
    <figure>
        <artwork><![CDATA[
fragment identifier resolution
------------------- ----------
# self, the root of the resource itself
#/foo the object referred to by the foo property
#/foo/another%20prop the object referred to by the "another prop"
property of the object referred to by the
"foo" property
#/foo/another%20prop/baz the string referred to by the value of "baz"
property of the "another prop" property of
the object referred to by the "foo" property
#/foo/anArray/0 the first object in the "anArray" array
]]></artwork>
</figure>
</t>
</section>
<section title="dot-delimited fragment resolution">
<t>The dot-delimited fragment resolution protocol is the same as
slash-delimited fragment resolution protocol except that the "." character
(\x2E) is used as the delimiter between property names (instead of "/") and
the path does not need to start with a ".". For example, #.foo and #foo are a valid fragment
identifiers for referencing the value of the foo propery.</t>
</section>


</section>

<section title="readonly">
<t>This attribute indicates that the instance property SHOULD NOT be changed. Attempts by a user agent to modify the value of this property are expected to be rejected by a server.</t>
</section>
<section title="contentEncoding"><t>
If the instance property value is a string, this attribute defines that the string SHOULD be interpreted as binary data and decoded using the encoding named by this schema property. <xref target='RFC2045'>RFC 2045, Sec 6.1</xref> lists the possible values for this property.
</t>
</section>

<section title="pathStart">
<t>
This attribute is a URI that defines what the instance's URI MUST start with in order to validate.
The value of the "pathStart" attribute MUST be resolved as per <xref target='RFC3986'>RFC 3986, Sec 5</xref>,
and is relative to the instance's URI.
</t>
<t>
When multiple schemas have been referenced for an instance, the user agent
can determine if this schema is applicable for a particular instance by
determining if the URI of the instance begins with the the value of the "pathStart"
attribute. If the URI of the instance does not start with this URI,
or if another schema specifies a starting URI that is longer and also matches the
instance, this schema SHOULD NOT be applied to the instance. Any schema
that does not have a pathStart attribute SHOULD be considered applicable
to all the instances for which it is referenced.
</t>
</section>

<section title="mediaType">
<t>This attribute defines the media type of the instance representations that this schema is defining.
</t>

</section>


</section>

<section title="Security Considerations">
<t>
This specification is a sub-type of the JSON format, and
consequently the security considerations are generally the same as <xref target='RFC4627'>RFC 4627</xref>.
However, an additional issue is that when link relation of "self"
is used to denote a full representation of an object, the user agent
SHOULD NOT consider the representation to be the authoritative representation
of the resource denoted by the target URI if the target URI is not
equivalent to or a sub-path of the the URI used to request the resource
representation which contains the target URI with the "self" link.
For example, if a hyper schema was defined:
    <figure>
        <artwork><![CDATA[
{
"links":[
{
"rel":"self",
"href":"{id}"
}
]
}
]]></artwork>
</figure>
And a resource was requested from somesite.com:
    <figure>
        <artwork><![CDATA[
GET /foo/
]]></artwork>
</figure>

With a response of:
    <figure>
        <artwork><![CDATA[
Content-Type: application/json; profile=/schema-for-this-data
[
{"id":"bar", "name":"This representation can be safely treated \
as authoritative "},
{"id":"/baz", "name":"This representation should not be treated as \
authoritative the user agent should make request the resource\
from "/baz" to ensure it has the authoritative representation"},
{"id":"http://othersite.com/something", "name":"This representation\
should also not be treated as authoritative and the target\
resource representation should be retrieved for the\
authoritative representation"}
]
]]></artwork>
</figure>
</t>
</section>
<section title="IANA Considerations">
<t>
   The proposed MIME media type for JSON Schema is "application/schema+json".
</t>
<t>
   Type name: application
</t>
<t>
   Subtype name: schema+json
</t>
<t>
   Required parameters: profile
   </t>
   <t>
    The value of the profile parameter SHOULD be a URI (relative or absolute) that
    refers to the schema used to define the structure of this structure (the
    meta-schema). Normally the value would be http://json-schema.org/draft-03/hyper-schema,
    but it is allowable to use other schemas that extend the hyper schema's meta-
    schema.
</t>
<t>
   Optional parameters: pretty
   </t>
   <t>
    The value of the pretty parameter MAY be true or false to indicate if additional
    whitespace has been included to make the JSON representation easier to read.
</t>

<section title="Registry of Link Relations">
<t>
This registry is maintained by IANA per <xref target='RFC4287'>RFC 4287</xref> and this specification adds
four values: "full", "create", "instances", "root". New
   assignments are subject to IESG Approval, as outlined in <xref target='RFC5226'>RFC 5226</xref>.
   Requests should be made by email to IANA, which will then forward the
   request to the IESG, requesting approval.

</t>
</section>

</section>
  </middle>

  <back>
    <!-- References Section -->


    <references title="Normative References">
      &rfc2045;
      &rfc2119;
      &rfc2396;
      &rfc3339;
      &rfc3986;
      &rfc4287;
    </references>

    <references title="Informative References">
      &rfc2616;
      &rfc4627;
      &rfc5226;
      &iddiscovery;
      &uritemplate;
      &linkheader;
      &html401;
      &css21;
    </references>

    <!--
<section anchor="appendix" title="Appendix A">
<t>You can add appendices just as regular sections, the only
difference is that they go under "back" element, and get letters
instead of numbers</t>
</section>
-->

    <section title="Change Log">
      <t>
        <list style="hanging">
          <t hangText="draft-03">
            <list style="symbols">
              <t>Added example and verbiage to "extends" attribute.</t>
              <t>Defined slash-delimited to use a leading slash.</t>
              <t>Made "root" a relation instead of an attribute.</t>
              <t>Removed address values, and MIME media type from format to reduce confusion (mediaType already exists, so it can be used for MIME types).</t>
              <t>Added more explanation of nullability.</t>
              <t>Removed "alternate" attribute.</t>
              <t>Upper cased many normative usages of must, may, and should.</t>
              <t>Replaced the link submission "properties" attribute to "schema" attribute.</t>
              <t>Replaced "optional" attribute with "required" attribute.</t>
              <t>Replaced "maximumCanEqual" attribute with "exclusiveMaximum" attribute.</t>
              <t>Replaced "minimumCanEqual" attribute with "exclusiveMinimum" attribute.</t>
              <t>Replaced "requires" attribute with "dependencies" attribute.</t>
              <t>Moved "contentEncoding" attribute to hyper schema.</t>
              <t>Added "additionalItems" attribute.</t>
              <t>Added "id" attribute.</t>
              <t>Switched self-referencing variable substitution from "-this" to "@" to align with reserved characters in URI template.</t>
              <t>Added "patternProperties" attribute.</t>
              <t>Schema URIs are now namespace versioned.</t>
              <t>Added "$ref" and "$schema" attributes.</t>
            </list>
          </t>
          <t hangText="draft-02">
            <list style="symbols">
              <t>Replaced "maxDecimal" attribute with "divisibleBy" attribute.</t>
              <t>Added slash-delimited fragment resolution protocol and made it the default.</t>
              <t>Added language about using links outside of schemas by referencing its normative URI.</t>
              <t>Added "uniqueItems" attribute.</t>
              <t>Added "targetSchema" attribute to link description object.</t>
              
            </list>
          </t>
          <t hangText="draft-01">
            <list style="symbols">
              <t>Fixed category and updates from template.</t>
            </list>
          </t>
          <t hangText="draft-00">
            <list style="symbols">
              <t>Initial draft.</t>
            </list>
          </t>
        </list>
      </t>
    </section>

    <section title="Open Issues">
      <t>
      <list>
      <t>Should we give a preference to MIME headers over Link headers (or only use one)?</t>
      <t>Should "root" be a MIME parameter?</t>
      <t>Should "format" be renamed to "mediaType" or "contentType" to reflect the usage MIME media types that are allowed?</t>
      <t>How should dates be handled?</t>
      </list>
      </t>
    </section>
    
  </back>
</rfc>
Something went wrong with that request. Please try again.