Skip to content

Commit e9b28ba

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 fc27304 commit e9b28ba

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
@@ -1159,68 +1159,76 @@
11591159
</section>
11601160
</section>
11611161

1162-
<section title='"title" and "description"'>
1162+
<section title="Basic annotation keywords">
11631163
<t>
1164-
The value of both of these keywords MUST be a string.
1164+
These general-purpose annotation keywords provide commonly used information
1165+
for documentation and user interface display purposes. They are not intended
1166+
to form a comprehensive set of features. Rather, additional vocabularies
1167+
can be defined for more complex annotation-based applications.
11651168
</t>
1166-
<t>
1167-
Both of these keywords can be used to decorate a user interface with
1168-
information about the data produced by this user interface. A title will
1169-
preferably be short, whereas a description will provide explanation about
1170-
the purpose of the instance described by this schema.
1171-
</t>
1172-
</section>
1169+
<section title='"title" and "description"'>
1170+
<t>
1171+
The value of both of these keywords MUST be a string.
1172+
</t>
1173+
<t>
1174+
Both of these keywords can be used to decorate a user interface with
1175+
information about the data produced by this user interface. A title will
1176+
preferably be short, whereas a description will provide explanation about
1177+
the purpose of the instance described by this schema.
1178+
</t>
1179+
</section>
11731180

1174-
<section title='"default"'>
1175-
<t>
1176-
There are no restrictions placed on the value of this keyword.
1177-
</t>
1178-
<t>
1179-
This keyword can be used to supply a default JSON value associated with a
1180-
particular schema. It is RECOMMENDED that a default value be valid against
1181-
the associated schema.
1182-
</t>
1183-
</section>
1181+
<section title='"default"'>
1182+
<t>
1183+
There are no restrictions placed on the value of this keyword.
1184+
</t>
1185+
<t>
1186+
This keyword can be used to supply a default JSON value associated with a
1187+
particular schema. It is RECOMMENDED that a default value be valid against
1188+
the associated schema.
1189+
</t>
1190+
</section>
11841191

1185-
<section title='"readOnly"'>
1186-
<t>
1187-
The value of this keyword MUST be a boolean.
1188-
</t>
1189-
<t>
1190-
If it has a value of boolean true, this keyword indicates that the value of the
1191-
instance is managed exclusively by the owning authority, and attempts by an
1192-
application to modify the value of this property are expected to be ignored or
1193-
rejected by that owning authority.
1194-
</t>
1195-
<t>
1196-
For example, this property would be used to mark a database-generated serial
1197-
number as read-only.
1198-
</t>
1199-
<t>
1200-
This keyword can be used to assist in user interface instance generation.
1201-
</t>
1202-
<t>
1203-
Omitting this keyword has the same behavior as a value of false.
1204-
</t>
1205-
</section>
1192+
<section title='"readOnly"'>
1193+
<t>
1194+
The value of this keyword MUST be a boolean.
1195+
</t>
1196+
<t>
1197+
If it has a value of boolean true, this keyword indicates that the value of the
1198+
instance is managed exclusively by the owning authority, and attempts by an
1199+
application to modify the value of this property are expected to be ignored or
1200+
rejected by that owning authority.
1201+
</t>
1202+
<t>
1203+
For example, this property would be used to mark a database-generated serial
1204+
number as read-only.
1205+
</t>
1206+
<t>
1207+
This keyword can be used to assist in user interface instance generation.
1208+
</t>
1209+
<t>
1210+
Omitting this keyword has the same behavior as a value of false.
1211+
</t>
1212+
</section>
12061213

1207-
<section title='"examples"'>
1208-
<t>
1209-
The value of this keyword MUST be an array.
1210-
There are no restrictions placed on the values within the array.
1211-
</t>
1212-
<t>
1213-
This keyword can be used to provide sample JSON values associated with a
1214-
particular schema, for the purpose of illustrating usage. It is
1215-
RECOMMENDED that these values be valid against the associated schema.
1216-
</t>
1217-
<t>
1218-
Implementations MAY use the value of "default", if present, as
1219-
an additional example. If "examples" is absent, "default"
1220-
MAY still be used in this manner.
1221-
</t>
1222-
</section>
1214+
<section title='"examples"'>
1215+
<t>
1216+
The value of this keyword MUST be an array.
1217+
There are no restrictions placed on the values within the array.
1218+
</t>
1219+
<t>
1220+
This keyword can be used to provide sample JSON values associated with a
1221+
particular schema, for the purpose of illustrating usage. It is
1222+
RECOMMENDED that these values be valid against the associated schema.
1223+
</t>
1224+
<t>
1225+
Implementations MAY use the value of "default", if present, as
1226+
an additional example. If "examples" is absent, "default"
1227+
MAY still be used in this manner.
1228+
</t>
1229+
</section>
12231230

1231+
</section>
12241232
</section>
12251233

12261234
<section title="Security considerations">

0 commit comments

Comments
 (0)