-
-
Notifications
You must be signed in to change notification settings - Fork 309
/
Copy pathjsonschema-validation.xml
1530 lines (1450 loc) · 78.5 KB
/
jsonschema-validation.xml
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 RFC1123 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1123.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 RFC4122 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4122.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 RFC4648 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4648.xml">
<!ENTITY RFC5321 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5321.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 RFC8259 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.8259.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-bhutton-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>[email protected]</email>
</address>
</author>
<author fullname="Henry Andrews" initials="H" surname="Andrews" role="editor">
<address>
<email>[email protected]</email>
</address>
</author>
<author fullname="Ben Hutton" initials="B" surname="Hutton" role="editor">
<address>
<email>[email protected]</email>
<uri>https://jsonschema.dev</uri>
</address>
</author>
<date year="2020"/>
<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>
This document a pre-release identified as JSON Schema draft 2020-11-rc-0.
</t>
<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="https://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 asserts constraints on the structure of instance data.
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>
<t>
This specification defines a set of assertion keywords, as well as a small vocabulary
of metadata keywords that can be used to annotate the JSON instance with
useful information. The <xref target="format" /> keyword is intended primarily
as an annotation, but can optionally be used as an assertion. The
<xref target="content" /> keywords are annotations for working with documents
embedded as JSON strings.
</t>
</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>
Keywords that use regular expressions, or constrain the instance value
to be a regular expression, are subject to the interoperability
considerations for regular expressions in the
<xref target="json-schema">JSON Schema Core</xref> specification.
</t>
</section>
</section>
<section title="Meta-Schema" anchor="meta-schema">
<t>
The current URI for the default JSON Schema dialect meta-schema is
<eref target="https://json-schema.org/draft/2020-11/schema"/>.
For schema author convenience, this meta-schema describes a dialect
consisting of all vocabularies
defined in this specification and the JSON Schema Core specification,
as well as two former keywords which are reserved for a transitional period.
Individual vocabulary and vocabulary meta-schema URIs are given for
each section below. Certain vocabularies are optional to support, which
is explained in detail in the relevant sections.
</t>
<t>
Updated vocabulary and meta-schema URIs MAY be published between
specification drafts in order to correct errors. Implementations
SHOULD consider URIs dated after this specification draft and
before the next to indicate the same syntax and semantics
as those listed here.
</t>
</section>
<section title="A Vocabulary for Structural Validation">
<t>
Validation keywords in a schema impose requirements for successful validation of an
instance. These keywords are all assertions without any annotation behavior.
</t>
<t>
Meta-schemas that do not use "$vocabulary" SHOULD be considered to
require this vocabulary as if its URI were present with a value of true.
</t>
<t>
The current URI for this vocabulary, known as the Validation vocabulary, is:
<https://json-schema.org/draft/2020-11/vocab/validation>.
</t>
<t>
The current URI for the corresponding meta-schema is:
<eref target="https://json-schema.org/draft/2020-11/meta/validation"/>.
</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" anchor="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 type, including null.
</t>
</section>
<section title="const">
<t>
The value of this keyword MAY be of any type, including null.
</t>
<t>
Use of this keyword is functionally equivalent to an
<xref target="enum">"enum"</xref> with a single value.
</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 a 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 a 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="RFC8259">RFC 8259</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="RFC8259">RFC 8259</xref>.
</t>
<t>
Omitting this keyword has the same behavior as a value of 0.
</t>
</section>
<section title="pattern" anchor="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="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="maxContains">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An array instance is valid against "maxContains" if the number of
elements that are valid against the schema for
<xref target="json-schema">"contains"</xref> is
less than, or equal to, the value of this keyword.
</t>
<t>
If "contains" is not present within the same schema object,
then this keyword has no effect.
</t>
</section>
<section title="minContains">
<t>
The value of this keyword MUST be a non-negative integer.
</t>
<t>
An array instance is valid against "minContains" if the number of
elements that are valid against the schema for
<xref target="json-schema">"contains"</xref> is
greater than, or equal to, the value of this keyword.
</t>
<t>
A value of 0 is allowed, but is only useful for setting a range
of occurrences from 0 to the value of "maxContains". A value of
0 with no "maxContains" causes "contains" to always pass validation.
</t>
<t>
If "contains" is not present within the same schema object,
then this keyword has no effect.
</t>
<t>
Omitting this keyword has the same behavior as a value of 1.
</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="dependentRequired">
<t>
The value of this keyword MUST be an object. Properties in
this object, if any, MUST be arrays. Elements in each array,
if any, MUST be strings, and MUST be unique.
</t>
<t>
This keyword specifies properties that are required if a specific
other property is present. Their requirement is dependent on the
presence of the other property.
</t>
<t>
Validation succeeds if, for each name that appears in both
the instance and as a name within this keyword's value, every
item in the corresponding array is also the name of a property
in the instance.
</t>
<t>
Omitting this keyword has the same behavior as an empty object.
</t>
</section>
</section>
</section>
<section title='A Vocabulary for Semantic Content With "format"' anchor="format">
<section title="Foreword">
<t>
Structural validation alone may be insufficient to allow an application to correctly
utilize certain values. The "format" annotation keyword is defined to allow schema
authors to convey semantic information 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. All format attributes defined
in this section apply to strings, but a format attribute can be specified
to apply to any instance types defined in the data model defined in the
<xref target="json-schema">core JSON Schema.</xref>
<cref>
Note that the "type" keyword in this specification defines an "integer" type
which is not part of the data model. Therefore a format attribute can be
limited to numbers, but not specifically to integers. However, a numeric
format can be used alongside the "type" keyword with a value of "integer",
or could be explicitly defined to always pass if the number is not an integer,
which produces essentially the same behavior as only applying to integers.
</cref>
</t>
<t>
The current URI for this vocabulary, known as the Format-Annotation vocabulary, is:
<https://json-schema.org/draft/2020-11/vocab/format-annotation>. This vocabulary
is required by this specification.
</t>
<t>
In addition to the Format-Annotation vocabulary, a secondary vocabulary is available
for custom meta-schemas that defines "format" as an assertion. The URI for the
Format-Assertion vocabulary, is:
<https://json-schema.org/draft/2020-11/vocab/format-assertation>.
</t>
<t>
The current URI for the corresponding meta-schema is:
<eref target="https://json-schema.org/draft/2020-11/meta/format"/>. Because the
syntactic requirements of "format" do not change between the annotation and assertion
vocabularies, the meta-schema is shared between them.
</t>
<t>
Specifying both the Format-Annotation and the Format-Assertion vocabularies is functionally
equivalent to specifying only the Format-Assertion vocabulary since its requirements
are a superset of the Format-Annotation vocabulary.
</t>
</section>
<section title="Implementation Requirements">
<t>
The "format" keyword functions as defined by the vocabulary which is referenced.
</t>
<section title="Format-Annotation Vocabulary">
<t>
The value of format MUST be collected as an annotation, if the implementation
supports annotation collection. This enables application-level validation when
schema validation is unavailable or inadequate.
</t>
<t>
Implementations MAY still treat "format" as an assertion in addition to an
annotation and attempt to validate the value's conformance to the specified
semantics. The implementation MUST provide options to enable and disable such
evaluation and MUST be disabled by default. Implementations SHOULD document
their level of support for such validation.
<cref>
Specifying the Format-Annotation vocabulary and enabling validation in an
implementation should not be viewed as being equivalent to specifying
the Format-Assertion vocabulary since implementations are not required to
provide full validation support when the Format-Assertion vocabulary
is not specified.
</cref>
</t>
<t>
When the implementation is configured for assertion behavior, it:
<list>
<t>
SHOULD provide an implementation-specific best effort validation
for each format attribute defined below;
</t>
<t>
MAY choose to implement validation of any or all format attributes
as a no-op by always producing a validation result of true;
</t>
</list>
<cref>
This matches the current reality of implementations, which provide
widely varying levels of validation, including no validation at all,
for some or all format attributes. It is also designed to encourage
relying only on the annotation behavior and performing semantic
validation in the application, which is the recommended best practice.
</cref>
</t>
</section>
<section title="Format-Assertion Vocabulary">
<t>
When the Format-Assertion vocabulary is declared with a value of false,
implementations MUST provide full validation support for all of the formats
defined by this specificaion. Implementations that cannot provide full
validation support MUST refuse to process the schema.
</t>
<t>
An implementation that supports the Format-Assertion vocabulary:
<list>
<t>
MUST still collect "format" as an annotation if the implementation
supports annotation collection;
</t>
<t>
MUST evaluate "format" as an assertion;
</t>
<t>
MUST implement syntactic validation for all format attributes defined
in this specification, and for any additional format attributes that
it recognizes, such that there exist possible instance values
of the correct type that will fail validation.
</t>
</list>
The requirement for minimal validation of format attributes is intentionally
vague and permissive, due to the complexity involved in many of the attributes.
Note in particular that the requirement is limited to syntactic checking; it is
not to be expected that an implementation would send an email, attempt to connect
to a URL, or otherwise check the existence of an entity identified by a format
instance.
<cref>
The expectation is that for simple formats such as date-time, syntactic
validation will be thorough. For a complex format such as email addresses,
which are the amalgamation of various standards and numerous adjustments
over time, with obscure and/or obsolete rules that may or may not be
restricted by other applications making use of the value, a minimal validation
is sufficient. For example, an instance string that does not contain
an "@" is clearly not a valid email address, and an "email" or "hostname"
containing characters outside of 7-bit ASCII is likewise clearly invalid.
</cref>
</t>
<t>
It is RECOMMENDED that implementations use a common parsing library for each format,
or a well-known regular expression. Implementations SHOULD clearly document
how and to what degree each format attribute is validated.
</t>
<t>
The <xref target="meta-schema">standard core and validation meta-schema</xref>
includes this vocabulary in its "$vocabulary" keyword with a value of false,
since by default implementations are not required to support this keyword
as an assertion. Supporting the format vocabulary with a value of true is
understood to greatly increase code size and in some cases execution time,
and will not be appropriate for all implementations.
</t>
</section>
<section title="Custom format attributes">
<t>
Implementations MAY support custom format attributes. Save for agreement between
parties, schema authors SHALL NOT expect a peer implementation to support such
custom format attributes. An implementation MUST NOT fail
validation or cease processing due to an unknown format attribute.
When treating "format" as an annotation, implementations SHOULD collect both
known and unknown format attribute values.
</t>
<t>
Vocabularies do not support specifically declaring different value sets for keywords.
Due to this limitation, and the historically uneven implementation of this keyword,
it is RECOMMENDED to define additional keywords in a custom vocabulary rather than
additional format attributes if interoperability is desired.
</t>
</section>
</section>
<section title="Defined Formats">
<section title="Dates, Times, and Duration">
<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>.
The duration format is from the ISO 8601 ABNF as given
in Appendix A of RFC 3339.
</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>
<t hangText="duration:">
A string instance is valid against this attribute if it is
a valid representation according to the "duration" production.
</t>
</list>
</t>
<t>
Implementations MAY support additional attributes using the other
production names defined anywhere in that RFC. 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 the "Mailbox" ABNF rule in
<xref target="RFC5321">RFC 5321, section 4.1.2</xref>.
</t>
<t hangText="idn-email:">
As defined by the extended "Mailbox" ABNF rule in
<xref target="RFC6531">RFC 6531, section 3.3</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="RFC1123">RFC 1123, section 2.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 1123 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
syntax as defined in
<xref target="RFC2673">RFC 2673, section 3.2</xref>.
</t>
<t hangText="ipv6:">
An IPv6 address as defined in
<xref target="RFC4291">RFC 4291, section 2.2</xref>.
</t>
</list>
</t>
</section>
<section title="Resource Identifiers">
<t>
These attributes apply to string instances.
</t>
<t>
<list style="hanging">
<t hangText="uri:">
A string instance is valid against this attribute if it is
a valid URI, according to <xref target="RFC3986"/>.
</t>
<t hangText="uri-reference:">
A string instance is valid against this attribute if it is a valid URI
Reference (either a URI or a relative-reference),
according to <xref target="RFC3986"/>.
</t>
<t hangText="iri:">
A string instance is valid against this attribute if it is
a valid IRI, according to <xref target="RFC3987"/>.
</t>
<t hangText="iri-reference:">
A string instance is valid against this attribute if it is a valid IRI
Reference (either an IRI or a relative-reference),
according to <xref target="RFC3987"/>.
</t>
<t hangText="uuid:">
A string instance is valid against this attribute if it is a valid
string representation of a UUID, according to <xref target="RFC4122"/>.
</t>
</list>
</t>
<t>
Note that all valid URIs are valid IRIs, and all valid URI References are
also valid IRI References.
</t>
<t>
Note also that the "uuid" format is for plain UUIDs, not UUIDs in URNs. An example
is "f81d4fae-7dec-11d0-a765-00a0c91e6bf6". For UUIDs as URNs, use the "uri" format,
with a "pattern" regular expression of "^urn:uuid:" to indicate the URI scheme and
URN namespace.
</t>
</section>
<section title="uri-template">
<t>
This attribute applies to string instances.
</t>
<t>
A string instance is valid against this attribute if it is a valid URI Template
(of any level), according to <xref target="RFC6570"/>.
</t>
<t>
Note that URI Templates may be used for IRIs; there is no separate
IRI Template specification.
</t>
</section>
<section title="JSON Pointers">
<t>
These attributes apply to string instances.
</t>
<t>
<list style="hanging">
<t hangText="json-pointer:">
A string instance is valid against this attribute if it
is a valid JSON string representation of a JSON Pointer,
according to <xref target="RFC6901">RFC 6901, section 5</xref>.
</t>
<t hangText="relative-json-pointer:">
A string instance is valid against this attribute if it is a valid
<xref target="relative-json-pointer">Relative JSON Pointer</xref>.
</t>
</list>
To allow for both absolute and relative JSON Pointers, use "anyOf" or
"oneOf" to indicate support for either format.
</t>
</section>
<section title="regex">
<t>
This attribute applies to string instances.
</t>
<t>
A regular expression, which SHOULD be valid according to the
<xref target="ecma262">ECMA-262</xref> regular expression dialect.
</t>
<t>
Implementations that validate formats MUST accept at least the subset of
ECMA-262 defined in the <xref target="regexInterop">Regular Expressions</xref>
section of this specification, and SHOULD accept all valid ECMA-262 expressions.
</t>
</section>
</section>
</section>
<section title='A Vocabulary for the Contents of String-Encoded Data' anchor="content">
<section title="Foreword">
<t>
Annotations defined in this section indicate that an instance contains
non-JSON data encoded in a JSON string.
</t>
<t>
These properties provide additional information required to interpret JSON data
as rich multimedia documents. They describe the type of content, how it is encoded,
and/or how it may be validated. They do not function as validation assertions;
a malformed string-encoded document MUST NOT cause the containing instance
to be considered invalid.
</t>
<t>
Meta-schemas that do not use "$vocabulary" SHOULD be considered to
require this vocabulary as if its URI were present with a value of true.
</t>
<t>
The current URI for this vocabulary, known as the Content vocabulary, is:
<https://json-schema.org/draft/2020-11/vocab/content>.
</t>
<t>
The current URI for the corresponding meta-schema is:
<eref target="https://json-schema.org/draft/2020-11/meta/content"/>.
</t>
</section>
<section title="Implementation Requirements">
<t>
Due to security and performance concerns, as well as the open-ended nature of
possible content types, implementations MUST NOT automatically decode, parse,
and/or validate the string contents by default. This additionally supports
the use case of embedded documents intended for processing by a different
consumer than that which processed the containing document.
</t>
<t>
All keywords in this section apply only to strings, and have no
effect on other data types.
</t>
<t>
Implementations MAY offer the ability to decode, parse, and/or validate
the string contents automatically. However, it MUST NOT perform these
operations by default, and MUST provide the validation result of each
string-encoded document separately from the enclosing document. This
process SHOULD be equivalent to fully evaluating the instance against
the original schema, followed by using the annotations to decode, parse,
and/or validate each string-encoded document.
<cref>
For now, the exact mechanism of performing and returning parsed
data and/or validation results from such an automatic decoding, parsing,
and validating feature is left unspecified. Should such a feature
prove popular, it may be specified more thoroughly in a future draft.
</cref>
</t>
<t>
See also the <xref target="security">Security Considerations</xref>
sections for possible vulnerabilities introduced by automatically
processing the instance string according to these keywords.
</t>
</section>
<section title="contentEncoding">
<t>
If the instance value is a string, this property defines that the string
SHOULD be interpreted as binary data and decoded using the encoding
named by this property.
</t>
<t>
Possible values indicating base 16, 32, and 64 encodings with several
variations are listed in <xref target="RFC4648">RFC 4648</xref>. Additionally,
sections 6.7 and 6.8 of <xref target="RFC2045">RFC 2045</xref> provide
encodings used in MIME. As "base64" is defined in both RFCs, the definition
from RFC 4648 SHOULD be assumed unless the string is specifically intended
for use in a MIME context. Note that all of these encodings result in
strings consisting only of 7-bit ASCII characters. Therefore, this keyword
has no meaning for strings containing characters outside of that range.
</t>
<t>
If this keyword is absent, but "contentMediaType" is present, this
indicates that the encoding is the identity encoding, meaning that
no transformation was needed in order to represent the content in
a UTF-8 string.
</t>
<t>
The value of this property MUST be a string.
</t>
</section>
<section title="contentMediaType">
<t>
If the instance is a string, this property indicates the media type
of the contents of the string. If "contentEncoding" is present,
this property describes the decoded string.
</t>
<t>
The value of this property MUST be a string, which MUST be a media type,
as defined by <xref target="RFC2046">RFC 2046</xref>.
</t>
</section>