Skip to content

Commit 073cf57

Browse files
handrewshandrews
committed
Group annotation keywords in subsection
...with some intro text, and re-indentation, but no changes to the contents of the re-indented sections.
1 parent e848101 commit 073cf57

File tree

1 file changed

+64
-56
lines changed

1 file changed

+64
-56
lines changed

‎jsonschema-validation.xml

Lines changed: 64 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1196,68 +1196,76 @@
11961196
</section>
11971197
</section>
11981198

1199-
<section title='"title" and "description"'>
1199+
<section title="Basic annotation keywords">
12001200
<t>
1201-
The value of both of these keywords MUST be a string.
1201+
These general-purpose annotation keywords provide commonly used information
1202+
for documentation and user interface display purposes. They are not intended
1203+
to form a comprehensive set of features. Rather, additional vocabularies
1204+
can be defined for more complex annotation-based applications.
12021205
</t>
1203-
<t>
1204-
Both of these keywords can be used to decorate a user interface with
1205-
information about the data produced by this user interface. A title will
1206-
preferably be short, whereas a description will provide explanation about
1207-
the purpose of the instance described by this schema.
1208-
</t>
1209-
</section>
1206+
<section title='"title" and "description"'>
1207+
<t>
1208+
The value of both of these keywords MUST be a string.
1209+
</t>
1210+
<t>
1211+
Both of these keywords can be used to decorate a user interface with
1212+
information about the data produced by this user interface. A title will
1213+
preferably be short, whereas a description will provide explanation about
1214+
the purpose of the instance described by this schema.
1215+
</t>
1216+
</section>
12101217

1211-
<section title='"default"'>
1212-
<t>
1213-
There are no restrictions placed on the value of this keyword.
1214-
</t>
1215-
<t>
1216-
This keyword can be used to supply a default JSON value associated with a
1217-
particular schema. It is RECOMMENDED that a default value be valid against
1218-
the associated schema.
1219-
</t>
1220-
</section>
1218+
<section title='"default"'>
1219+
<t>
1220+
There are no restrictions placed on the value of this keyword.
1221+
</t>
1222+
<t>
1223+
This keyword can be used to supply a default JSON value associated with a
1224+
particular schema. It is RECOMMENDED that a default value be valid against
1225+
the associated schema.
1226+
</t>
1227+
</section>
12211228

1222-
<section title='"readOnly"'>
1223-
<t>
1224-
The value of this keyword MUST be a boolean.
1225-
</t>
1226-
<t>
1227-
If it has a value of boolean true, this keyword indicates that the value of the
1228-
instance is managed exclusively by the owning authority, and attempts by an
1229-
application to modify the value of this property are expected to be ignored or
1230-
rejected by that owning authority.
1231-
</t>
1232-
<t>
1233-
For example, this property would be used to mark a database-generated serial
1234-
number as read-only.
1235-
</t>
1236-
<t>
1237-
This keyword can be used to assist in user interface instance generation.
1238-
</t>
1239-
<t>
1240-
Omitting this keyword has the same behavior as a value of false.
1241-
</t>
1242-
</section>
1229+
<section title='"readOnly"'>
1230+
<t>
1231+
The value of this keyword MUST be a boolean.
1232+
</t>
1233+
<t>
1234+
If it has a value of boolean true, this keyword indicates that the value of the
1235+
instance is managed exclusively by the owning authority, and attempts by an
1236+
application to modify the value of this property are expected to be ignored or
1237+
rejected by that owning authority.
1238+
</t>
1239+
<t>
1240+
For example, this property would be used to mark a database-generated serial
1241+
number as read-only.
1242+
</t>
1243+
<t>
1244+
This keyword can be used to assist in user interface instance generation.
1245+
</t>
1246+
<t>
1247+
Omitting this keyword has the same behavior as a value of false.
1248+
</t>
1249+
</section>
12431250

1244-
<section title='"examples"'>
1245-
<t>
1246-
The value of this keyword MUST be an array.
1247-
There are no restrictions placed on the values within the array.
1248-
</t>
1249-
<t>
1250-
This keyword can be used to provide sample JSON values associated with a
1251-
particular schema, for the purpose of illustrating usage. It is
1252-
RECOMMENDED that these values be valid against the associated schema.
1253-
</t>
1254-
<t>
1255-
Implementations MAY use the value of "default", if present, as
1256-
an additional example. If "examples" is absent, "default"
1257-
MAY still be used in this manner.
1258-
</t>
1259-
</section>
1251+
<section title='"examples"'>
1252+
<t>
1253+
The value of this keyword MUST be an array.
1254+
There are no restrictions placed on the values within the array.
1255+
</t>
1256+
<t>
1257+
This keyword can be used to provide sample JSON values associated with a
1258+
particular schema, for the purpose of illustrating usage. It is
1259+
RECOMMENDED that these values be valid against the associated schema.
1260+
</t>
1261+
<t>
1262+
Implementations MAY use the value of "default", if present, as
1263+
an additional example. If "examples" is absent, "default"
1264+
MAY still be used in this manner.
1265+
</t>
1266+
</section>
12601267

1268+
</section>
12611269
</section>
12621270

12631271
<section title="Security considerations">

0 commit comments

Comments
 (0)