forked from json-schema-org/json-schema-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjsonschema-validation.xml
More file actions
1546 lines (1455 loc) · 75 KB
/
jsonschema-validation.xml
File metadata and controls
1546 lines (1455 loc) · 75 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
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC1034 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1034.xml">
<!ENTITY RFC2045 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2045.xml">
<!ENTITY RFC2046 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2046.xml">
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC2673 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2673.xml">
<!ENTITY RFC3339 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3339.xml">
<!ENTITY RFC3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
<!ENTITY RFC3987 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3987.xml">
<!ENTITY RFC4291 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4291.xml">
<!ENTITY RFC4329 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4329.xml">
<!ENTITY RFC5322 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5322.xml">
<!ENTITY RFC5890 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5890.xml">
<!ENTITY RFC5891 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5891.xml">
<!ENTITY RFC6531 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6531.xml">
<!ENTITY RFC6570 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6570.xml">
<!ENTITY RFC6901 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6901.xml">
<!ENTITY RFC7159 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7159.xml">
]>
<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<?rfc strict="no"?>
<?rfc rfcedstyle="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes" ?>
<rfc category="info" docName="draft-handrews-json-schema-validation-00" ipr="trust200902">
<front>
<title abbrev="JSON Schema Validation">
JSON Schema Validation: A Vocabulary for Structural Validation of JSON
</title>
<author fullname="Austin Wright" initials="A" surname="Wright" role="editor">
<address>
<email>aaa@bzfx.net</email>
</address>
</author>
<author fullname="Henry Andrews" initials="H" surname="Andrews" role="editor">
<organization>Cloudflare, Inc.</organization>
<address>
<postal>
<street></street>
<city>San Francisco</city>
<region>CA</region>
<country>USA</country>
</postal>
<email>henry@cloudflare.com</email>
</address>
</author>
<author fullname="Geraint Luff" initials="G" surname="Luff">
<address>
<postal>
<street></street>
<city>Cambridge</city>
<country>UK</country>
</postal>
<email>luffgd@gmail.com</email>
</address>
</author>
<date year="2018"/>
<workgroup>Internet Engineering Task Force</workgroup>
<keyword>JSON</keyword>
<keyword>Schema</keyword>
<keyword>validation</keyword>
<abstract>
<t>
JSON Schema (application/schema+json) has several purposes, one of which is JSON
instance validation.
This document specifies a vocabulary for JSON Schema to describe the meaning of JSON
documents, provide hints for user interfaces working with JSON data, and to make
assertions about what a valid document must look like.
</t>
</abstract>
<note title="Note to Readers">
<t>
The issues list for this draft can be found at
<eref target="https://github.com/json-schema-org/json-schema-spec/issues"/>.
</t>
<t>
For additional information, see <eref target="http://json-schema.org/"/>.
</t>
<t>
To provide feedback, use this issue tracker, the communication methods listed on the
homepage, or email the document editors.
</t>
</note>
</front>
<middle>
<section title="Introduction">
<t>
JSON Schema can be used to require that a given JSON document (an instance)
satisfies a certain number of criteria. These criteria are asserted by using
keywords described in this specification. In addition, a set of keywords
is also defined to assist in interactive user interface instance generation.
</t>
<t>
This specification will use the concepts, syntax, and terminology defined
by the <xref target="json-schema">JSON Schema core</xref> specification.
</t>
</section>
<section title="Conventions and Terminology">
<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>
<t>
This specification uses the term "container instance" to refer to both array and
object instances. It uses the term "children instances" to refer to array elements
or object member values.
</t>
<t>
Elements in an array value are said to be unique if no two elements of this array
are <xref target="json-schema">equal</xref>.
</t>
</section>
<section title="Overview">
<t>
JSON Schema validation applies schemas to locations within the instance,
and asserts constraints on the structure of the data at each location.
An instance location that satisfies all asserted constraints is then
annotated with any keywords that contain non-assertion information,
such as descriptive metadata and usage hints. If all locations within
the instance satisfy all asserted constraints, then the instance is
said to be valid against the schema.
</t>
<t>
Each schema object is independently evaluated against each instance location
to which it applies. This greatly simplifies the implementation requirements
for validators by ensuring that they do not need to maintain state across
the document-wide validation process.
</t>
<section title="Applicability">
<t>
Validation begins by applying the root schema to the complete instance
document. From there, various keywords are used to determine which additional
subschemas are applied to either the current location, or a child location.
These keywords also define whether and how subschema assertion results are
modified and/or combined. Such keywords do not assert conditions on their
own. Rather, they control how assertions are applied and evaluated.
</t>
<t>
The keywords in the <xref target="logic">boolean logic</xref> and
<xref target="conditional">conditional</xref> sections of this specification
apply subschemas to the same location as the parent schema. The former group
defines boolean operations on the subschema assertion results, while the
latter evaluates one subschema and uses its assertion results to determine
which of two other subschemas to apply as well.
</t>
<t>
Several keywords determine which subschemas are applied to array items,
object property values, and object property names. They are:
"items", "additionalItems", "contains", "properties", "patternProperties",
"additionalProperties", and "propertyNames". The "contains" keyword only
requires its subschema to be valid against at least one child instance, while
the other keywords require that all subschemas are valid against all child
instances to which they apply.
</t>
<section title="Keyword Independence">
<t>
Validation keywords typically operate independently, without
affecting each other's outcomes.
</t>
<t>
For schema author convenience, there are some exceptions among the
keywords that control subschema applicability:
<list>
<t>
"additionalProperties", whose behavior is defined in terms of
"properties" and "patternProperties"; and
</t>
<t>
"additionalItems", whose behavior is defined in terms of "items".
</t>
</list>
</t>
</section>
</section>
<section title="Assertions" anchor="assertions">
<t>
Validation is a process of checking assertions. Each assertion adds
constraints that an instance must satisfy in order to successfully validate.
</t>
<t>
Assertion keywords that are absent never restrict validation.
In some cases, this no-op behavior is identical to a keyword that exists with
certain values, and these values are noted where known.
</t>
<t>
All of the keywords in the <xref target="general">general</xref>,
<xref target="numeric">numeric</xref>, and <xref target="string">string</xref>
sections are assertions, as well as "minItems", "maxItems", "uniqueItems",
"minProperties", "maxProperties", and "required". Additionally, "dependencies"
is shorthand for a combination of conditional and assertion keywords.
</t>
<t>
The "format", "contentType", and "contentEncoding" keywords can also be
implemented as assertions, although that functionality is an optional part
of this specification, and the keywords convey additional non-assertion
information.
</t>
<section title="Assertions and Instance Primitive Types">
<t>
Most validation assertions only constrain values within a certain
primitive type. When the type of the instance is not of the type
targeted by the keyword, the instance is considered to conform
to the assertion.
</t>
<t>
For example, the "maxLength" keyword will only restrict certain strings
(that are too long) from being valid. If the instance is a number,
boolean, null, array, or object, then it is valid against this assertion.
</t>
</section>
</section>
<section title="Annotations" anchor="annotations">
<t>
In addition to assertions, this specification provides a small vocabulary
of metadata keywords that can be used to annotate the JSON instance with
useful information. The <xref target="format" /> and <xref target="content" />
keywords are also useful as annotations as well as being optional assertions,
as they convey additional usage guidance for the instance data.
</t>
<t>
A schema that is applicable to a particular location in the instance, against
which the instance location is valid, attaches its annotations to that location
in the instance. Since many subschemas can be applicable to any single
location, annotation keywords need to specify any unusual handling of
multiple applicable occurrences of the keyword with different values.
The default behavior is simply to collect all values.
</t>
<t>
Additional vocabularies SHOULD make use of this mechanism for applying
their own annotations to instances.
</t>
<section title="Negated Schemas">
<t>
Annotations in a subschema contained within a "not", at any depth,
including any number of intervening additional "not" subschemas, MUST be
ignored. Similarly, annotations within a failing branch of a "oneOf",
"anyOf", "then", or "else" MUST be ignored.
</t>
</section>
<section title="Annotations and Short-Circuit Validation">
<t>
Annotation keywords MUST be applied to all possible sub-instances.
Even if such application can be short-circuited when only assertion
evaluation is needed. For instance, the "contains" keyword need only
be checked for assertions until at least one array item proves valid.
However, when working with annotations, all items in the array must
be evaluated to determine all items with which the annotations should
be associated.
</t>
</section>
</section>
</section>
<section title="Interoperability Considerations">
<section title="Validation of String Instances">
<t>
It should be noted that the nul character (\u0000) is valid in a JSON string. An
instance to validate may contain a string value with this character, regardless
of the ability of the underlying programming language to deal with such data.
</t>
</section>
<section title="Validation of Numeric Instances">
<t>
The JSON specification allows numbers with arbitrary precision, and JSON Schema
does not add any such bounds.
This means that numeric instances processed by JSON Schema can be arbitrarily large and/or
have an arbitrarily long decimal part, regardless of the ability of the
underlying programming language to deal with such data.
</t>
</section>
<section title="Regular Expressions" anchor="regexInterop">
<t>
Two validation keywords, "pattern" and "patternProperties", use regular
expressions to express constraints, and the "regex" value for the
"format" keyword constrains the instance value to be a regular expression.
These regular expressions SHOULD be valid according to the
<xref target="ecma262">ECMA 262</xref> regular expression dialect.
</t>
<t>
Furthermore, given the high disparity in regular expression constructs support,
schema authors SHOULD limit themselves to the following regular expression
tokens:
<list>
<t>individual Unicode characters, as defined by the <xref
target="RFC7159">JSON specification</xref>;</t>
<t>simple character classes ([abc]), range character classes ([a-z]);</t>
<t>complemented character classes ([^abc], [^a-z]);</t>
<t>simple quantifiers: "+" (one or more), "*" (zero or more), "?" (zero or
one), and their lazy versions ("+?", "*?", "??");</t>
<t>range quantifiers: "{x}" (exactly x occurrences), "{x,y}" (at least x, at
most y, occurrences), {x,} (x occurrences or more), and their lazy
versions;</t>
<t>the beginning-of-input ("^") and end-of-input ("$") anchors;</t>
<t>simple grouping ("(...)") and alternation ("|").</t>
</list>
</t>
<t>
Finally, implementations MUST NOT take regular expressions to be
anchored, neither at the beginning nor at the end. This means, for instance,
the pattern "es" matches "expression".
</t>
</section>
</section>
<section title="Meta-Schema">
<t>
The current URI for the JSON Schema Validation is
<eref target="http://json-schema.org/draft-07/schema#"/>.
</t>
</section>
<section title="Validation Keywords">
<t>
Validation keywords in a schema impose requirements for successful validation of an
instance.
</t>
<section title="Validation Keywords for Any Instance Type" anchor="general">
<section title="type">
<t>
The value of this keyword MUST be either a string or an array. If it is
an array, elements of the array MUST be strings and MUST be unique.
</t>
<t>
String values MUST be one of the six primitive types
("null", "boolean", "object", "array", "number", or "string"),
or "integer" which matches any number with a zero fractional part.
</t>
<t>
An instance validates if and only if the instance is in any of the sets listed
for this keyword.
</t>
</section>
<section title="enum">
<t>
The value of this keyword MUST be an array. This array SHOULD have at
least one element. Elements in the array SHOULD be unique.
</t>
<t>
An instance validates successfully against this keyword if its value is
equal to one of the elements in this keyword's array value.
</t>
<t>
Elements in the array might be of any value, including null.
</t>
</section>
<section title="const">
<t>
The value of this keyword MAY be of any type, including null.
</t>
<t>
An instance validates successfully against this keyword if its value is
equal to the value of the keyword.
</t>
</section>
</section>
<section title="Validation Keywords for Numeric Instances (number and integer)"
anchor="numeric">
<section title="multipleOf">
<t>
The value of "multipleOf" MUST be a number, strictly greater than 0.
</t>
<t>
A numeric instance is valid only if division by this keyword's value results in
an integer.
</t>
</section>
<section title="maximum">
<t>
The value of "maximum" MUST be a number, representing an inclusive upper limit
for a numeric instance.
</t>
<t>
If the instance is a number, then this keyword validates only if the instance is
less than or exactly equal to "maximum".
</t>
</section>
<section title="exclusiveMaximum">
<t>
The value of "exclusiveMaximum" MUST be number, representing an exclusive upper
limit for a numeric instance.
</t>
<t>
If the instance is a number, then the instance is valid only if it has a value
strictly less than (not equal to) "exclusiveMaximum".
</t>
</section>
<section title="minimum">
<t>
The value of "minimum" MUST be a number, representing an inclusive lower limit
for a numeric instance.
</t>
<t>
If the instance is a number, then this keyword validates only if the instance is
greater than or exactly equal to "minimum".
</t>
</section>
<section title="exclusiveMinimum">
<t>
The value of "exclusiveMinimum" MUST be number, representing an exclusive lower
limit for a numeric instance.
</t>
<t>
If the instance is a number, then the instance is valid only if it has a value
strictly greater than (not equal to) "exclusiveMinimum".
</t>
</section>
</section>
<section title="Validation Keywords for Strings" anchor="string">
<section title="maxLength">
<t>
The value of this keyword MUST be a non-negative integer.</t>
<t>
A string instance is valid against this keyword if its
length is less than, or equal to, the value of this keyword.
</t>
<t>
The length of a string instance is defined as the number of its
characters as defined by <xref target="RFC7159">RFC 7159</xref>.
</t>
</section>
<section title="minLength">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
A string instance is valid against this keyword if its
length is greater than, or equal to, the value of this keyword.
</t>
<t>
The length of a string instance is defined as the number of its
characters as defined by <xref target="RFC7159">RFC 7159</xref>.
</t>
<t>
Omitting this keyword has the same behavior as a value of 0.
</t>
</section>
<section title="pattern">
<t>
The value of this keyword MUST be a string. This string SHOULD be a
valid regular expression, according to the ECMA 262 regular expression
dialect.
</t>
<t>
A string instance is considered valid if the regular
expression matches the instance successfully. Recall: regular
expressions are not implicitly anchored.
</t>
</section>
</section>
<section title="Validation Keywords for Arrays">
<section title="items">
<t>
The value of "items" MUST be either a valid JSON Schema or an array of valid
JSON Schemas.
</t>
<t>
This keyword determines how child instances validate for arrays,
and does not directly validate the immediate instance itself.
</t>
<t>
If "items" is a schema, validation succeeds if all elements
in the array successfully validate against that schema.
</t>
<t>
If "items" is an array of schemas, validation succeeds if
each element of the instance validates against the schema at the
same position, if any.
</t>
<t>
Omitting this keyword has the same behavior as an empty schema.
</t>
</section>
<section title="additionalItems">
<t>
The value of "additionalItems" MUST be a valid JSON Schema.
</t>
<t>
This keyword determines how child instances validate for arrays,
and does not directly validate the immediate instance itself.
</t>
<t>
If "items" is an array of schemas, validation succeeds
if every instance element at a position greater than the size
of "items" validates against "additionalItems".
</t>
<t>
Otherwise, "additionalItems" MUST be ignored, as the "items"
schema (possibly the default value of an empty schema) is
applied to all elements.
</t>
<t>
Omitting this keyword has the same behavior as an empty schema.
</t>
</section>
<section title="maxItems">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An array instance is valid against "maxItems" if its size is
less than, or equal to, the value of this keyword.
</t>
</section>
<section title="minItems">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An array instance is valid against "minItems" if its size is
greater than, or equal to, the value of this keyword.
</t>
<t>
Omitting this keyword has the same behavior as a value of 0.
</t>
</section>
<section title="uniqueItems">
<t>
The value of this keyword MUST be a boolean.
</t>
<t>
If this keyword has boolean value false, the instance validates
successfully. If it has boolean value true, the instance validates
successfully if all of its elements are unique.
</t>
<t>
Omitting this keyword has the same behavior as a value of false.
</t>
</section>
<section title="contains">
<t>
The value of this keyword MUST be a valid JSON Schema.
</t>
<t>
An array instance is valid against "contains" if at least one of
its elements is valid against the given schema.
</t>
</section>
</section>
<section title="Validation Keywords for Objects">
<section title="maxProperties">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An object instance is valid against "maxProperties" if its
number of properties is less than, or equal to, the value of this
keyword.
</t>
</section>
<section title="minProperties">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An object instance is valid against "minProperties" if its
number of properties is greater than, or equal to, the value of this
keyword.
</t>
<t>
Omitting this keyword has the same behavior as a value of 0.
</t>
</section>
<section title="required">
<t>
The value of this keyword MUST be an array.
Elements of this array, if any, MUST be strings, and MUST be unique.
</t>
<t>
An object instance is valid against this keyword if every item in the array is
the name of a property in the instance.
</t>
<t>
Omitting this keyword has the same behavior as an empty array.
</t>
</section>
<section title="properties">
<t>
The value of "properties" MUST be an object.
Each value of this object MUST be a valid JSON Schema.
</t>
<t>
This keyword determines how child instances validate for objects,
and does not directly validate the immediate instance itself.
</t>
<t>
Validation succeeds if, for each name that appears in both
the instance and as a name within this keyword's value, the child
instance for that name successfully validates against the
corresponding schema.
</t>
<t>
Omitting this keyword has the same behavior as an empty object.
</t>
</section>
<section title="patternProperties">
<t>
The value of "patternProperties" MUST be an object. Each property name
of this object SHOULD be a valid regular expression, according to the
ECMA 262 regular expression dialect. Each property value of this object
MUST be a valid JSON Schema.
</t>
<t>
This keyword determines how child instances validate for objects,
and does not directly validate the immediate instance itself.
Validation of the primitive instance type against this keyword
always succeeds.
</t>
<t>
Validation succeeds if, for each instance name that matches any
regular expressions that appear as a property name in this keyword's value,
the child instance for that name successfully validates against each
schema that corresponds to a matching regular expression.
</t>
<t>
Omitting this keyword has the same behavior as an empty object.
</t>
</section>
<section title="additionalProperties">
<t>
The value of "additionalProperties" MUST be a valid JSON Schema.
</t>
<t>
This keyword determines how child instances validate for objects,
and does not directly validate the immediate instance itself.
</t>
<t>
Validation with "additionalProperties" applies only to the child
values of instance names that do not match any names in "properties",
and do not match any regular expression in "patternProperties".
</t>
<t>
For all such properties, validation succeeds if the child instance
validates against the "additionalProperties" schema.
</t>
<t>
Omitting this keyword has the same behavior as an empty schema.
</t>
</section>
<section title="dependencies">
<t>
<cref>
Now that "if", "then", and "else" are keywords, it is not clear whether
there is any benefit in keeping the schema form of "dependencies".
It is frequently misunderstood, and having a form that takes a subschema
as well as a form that takes a primitive value is particularly
confusing. And it seems to be rarely used. Depending on feedback
with "if", "then", and "else", the schema form of this keyword may
well be removed in a future draft. Current thought is that the string
form (giving property names in an array) is a useful shortcut.
</cref>
</t>
<t>
This keyword specifies rules that are evaluated if the instance is an object and
contains a certain property.
</t>
<t>
This keyword's value MUST be an object. Each property specifies a dependency.
Each dependency value MUST be an array or a valid JSON Schema.
</t>
<t>
If the dependency value is a subschema, and the dependency key is a property
in the instance, the entire instance must validate against the dependency value.
</t>
<t>
If the dependency value is an array, each element in the array,
if any, MUST be a string, and MUST be unique. If the dependency key is
a property in the instance, each of the items in the dependency
value must be a property that exists in the instance.
</t>
<t>
Omitting this keyword has the same behavior as an empty object.
</t>
</section>
<section title="propertyNames">
<t>
The value of "propertyNames" MUST be a valid JSON Schema.
</t>
<t>
If the instance is an object, this keyword validates if every property name in
the instance validates against the provided schema.
Note the property name that the schema is testing will always be a string.
</t>
<t>
Omitting this keyword has the same behavior as an empty schema.
</t>
</section>
</section>
<section title="Keywords for Applying Subschemas Conditionally" anchor="conditional">
<t>
These keywords work together to implement conditional
application of a subschema based on the outcome of
another subschema.
</t>
<t>
These keywords MUST NOT interact with each other across
subschema boundaries. In other words, an "if" in one
branch of an "allOf" MUST NOT have an impact on a "then"
or "else" in another branch.
</t>
<section title="if">
<t>
This keyword's value MUST be a valid JSON Schema.
</t>
<t>
Instances that successfully validate against this
keyword's subschema MUST also be valid against
the subschema value of the "then" keyword, if
present.
</t>
<t>
Instances that fail to validate against this
keyword's subschema MUST also be valid against
the subschema value of the "else" keyword.
</t>
<t>
Validation of the instance against this keyword
on its own always succeeds, regardless of the
validation outcome of against its subschema.
</t>
</section>
<section title="then">
<t>
This keyword's value MUST be a valid JSON Schema.
</t>
<t>
When present alongside of "if", the instance
successfully validates against this keyword if
it validates against both the "if"'s subschema
and this keyword's subschema.
</t>
<t>
When "if" is absent, or the instance fails to
validate against its subschema, validation against
this keyword always succeeds. Implementations
SHOULD avoid attempting to validate against
the subschema in these cases.
</t>
</section>
<section title="else">
<t>
This keyword's value MUST be a valid JSON Schema.
</t>
<t>
When present alongside of "if", the instance
successfully validates against this keyword if
it fails to validate against the "if"'s
subschema, and successfully validates against
this keyword's subschema.
</t>
<t>
When "if" is absent, or the instance successfully
validates against its subschema, validation against
this keyword always succeeds. Implementations
SHOULD avoid attempting to validate against
the subschema in these cases.
</t>
</section>
</section>
<section title="Keywords for Applying Subschemas With Boolean Logic" anchor="logic">
<section title="allOf">
<t>
This keyword's value MUST be a non-empty array.
Each item of the array MUST be a valid JSON Schema.
</t>
<t>
An instance validates successfully against this keyword if it validates
successfully against all schemas defined by this keyword's value.
</t>
</section>
<section title="anyOf">
<t>
This keyword's value MUST be a non-empty array.
Each item of the array MUST be a valid JSON Schema.
</t>
<t>
An instance validates successfully against this keyword if it validates
successfully against at least one schema defined by this keyword's value.
</t>
</section>
<section title="oneOf">
<t>
This keyword's value MUST be a non-empty array.
Each item of the array MUST be a valid JSON Schema.
</t>
<t>
An instance validates successfully against this keyword if it validates
successfully against exactly one schema defined by this keyword's value.
</t>
</section>
<section title="not">
<t>
This keyword's value MUST be a valid JSON Schema.
</t>
<t>
An instance is valid against this keyword if it fails to validate
successfully against the schema defined by this keyword.
</t>
</section>
</section>
</section>
<section title='Semantic Validation With "format"' anchor="format">
<section title="Foreword">
<t>
Structural validation alone may be insufficient to validate that an instance
meets all the requirements of an application. The "format" keyword is defined to
allow interoperable semantic validation for a fixed subset of values which are
accurately described by authoritative resources, be they RFCs or other external
specifications.
</t>
<t>
The value of this keyword is called a format attribute. It MUST be a string. A
format attribute can generally only validate a given set of instance types. If
the type of the instance to validate is not in this set, validation for this
format attribute and instance SHOULD succeed.
</t>
</section>
<section title="Implementation Requirements">
<t>
The "format" keyword functions as both an annotation
(<xref target="annotations" />) and as an assertion
(<xref target="assertions" />). While no special effort is required to
implement it as an annotation conveying semantic meaning, implementing
validation is non-trivial.
</t>
<t>
Implementations MAY support the "format" keyword as a validation assertion.
Should they choose to do so:
<list>
<t>they SHOULD implement validation for attributes defined below;</t>
<t>they SHOULD offer an option to disable validation for this keyword.</t>
</list>
</t>
<t>
Implementations MAY add custom format attributes. Save for agreement between
parties, schema authors SHALL NOT expect a peer implementation to support this
keyword and/or custom format attributes.
</t>
</section>
<section title="Defined Formats">
<section title="Dates and Times">
<t>
These attributes apply to string instances.
</t>
<t>
Date and time format names are derived from
<xref target="RFC3339">RFC 3339, section 5.6</xref>.
</t>
<t>
Implementations supporting formats SHOULD implement support for
the following attributes:
<list style="hanging">
<t hangText="date-time">
A string instance is valid against this attribute if it is
a valid representation according to the "date-time" production.
</t>
<t hangText="date">
A string instance is valid against this attribute if it is
a valid representation according to the "full-date" production.
</t>
<t hangText="time">
A string instance is valid against this attribute if it is
a valid representation according to the "full-time" production.
</t>
</list>
</t>
<t>
Implementations MAY support additional attributes using the other
production names defined in that section. If "full-date" or "full-time"
are implemented, the corresponding short form ("date" or "time"
respectively) MUST be implemented, and MUST behave identically.
Implementations SHOULD NOT define extension attributes
with any name matching an RFC 3339 production unless it validates
according to the rules of that production.
<cref>
There is not currently consensus on the need for supporting
all RFC 3339 formats, so this approach of reserving the
namespace will encourage experimentation without committing
to the entire set. Either the format implementation requirements
will become more flexible in general, or these will likely
either be promoted to fully specified attributes or dropped.
</cref>
</t>
</section>
<section title="Email Addresses">
<t>
These attributes apply to string instances.
</t>
<t>
A string instance is valid against these attributes if it is a valid
Internet email address as follows:
<list style="hanging">
<t hangText="email">
As defined by <xref target="RFC5322">RFC 5322, section 3.4.1</xref>.
</t>
<t hangText="idn-email">
As defined by <xref target="RFC6531">RFC 6531</xref>
</t>
</list>
Note that all strings valid against the "email" attribute are also
valid against the "idn-email" attribute.
</t>
</section>
<section title="Hostnames">
<t>
These attributes apply to string instances.
</t>
<t>
A string instance is valid against these attributes if it is a valid
representation for an Internet hostname as follows:
<list style="hanging">
<t hangText="hostname">
As defined by <xref target="RFC1034">RFC 1034, section 3.1</xref>,
including host names produced using the Punycode algorithm
specified in <xref target="RFC5891">RFC 5891, section 4.4</xref>.
</t>
<t hangText="idn-hostname">
As defined by either RFC 1034 as for hostname, or an
internationalized hostname as defined by
<xref target="RFC5890">RFC 5890, section 2.3.2.3</xref>.
</t>
</list>
Note that all strings valid against the "hostname" attribute are also
valid against the "idn-hostname" attribute.
</t>
</section>
<section title="IP Addresses">
<t>
These attributes apply to string instances.
</t>
<t>
A string instance is valid against these attributes if it is a valid
representation of an IP address as follows:
<list style="hanging">
<t hangText="ipv4">
An IPv4 address according to the "dotted-quad" ABNF