Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 6c490f1

Browse files
committed
Add the "examples" keyword.
This addresses issue #121. Most of the wording is lifted from "default", which is similar and can serve the same purpose. This wording explicitly allows for using "default" as an example, without requiring that implementations do so. The "MAY be used in a root schema or any subschema" line for all of the meta-data keywords seems to have been a holdover from an earlier approach of always specifying where keywords could be used. It is not done anywhere else and raised a red flag in review of the original version of this commit, so this version removes it from all meta-data keywords.
1 parent b5afae7 commit 6c490f1

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

‎jsonschema-validation.xml‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -666,9 +666,6 @@
666666
preferrably be short, whereas a description will provide explanation about
667667
the purpose of the instance described by this schema.
668668
</t>
669-
<t>
670-
Both of these keywords MAY be used in root schemas, and in any subschemas.
671-
</t>
672669
</section>
673670

674671
<section title='"default"'>
@@ -680,8 +677,22 @@
680677
particular schema. It is RECOMMENDED that a default value be valid against
681678
the associated schema.
682679
</t>
680+
</section>
681+
682+
<section title='"examples"'>
683+
<t>
684+
The value of this keyword MUST be an array.
685+
There are no restrictions placed on the values within the array.
686+
</t>
687+
<t>
688+
This keyword can be used to provide sample JSON values associated with a
689+
particular schema, for the purpose of illustrating usage. It is
690+
RECOMMENDED that these values be valid against the associated schema.
691+
</t>
683692
<t>
684-
This keyword MAY be used in root schemas, and in any subschemas.
693+
Implementations MAY use the value of "default", if present, as
694+
an additional example. If "examples" is absent, "default"
695+
MAY still be used in this manner.
685696
</t>
686697
</section>
687698

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /