Skip to content

Commit 121a4b7

Browse files
committed
Add a "secret" annotation
This is for passwords and other senstive or write-only fields.
1 parent abc40aa commit 121a4b7

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

jsonschema-validation.xml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,6 +1253,27 @@
12531253
</t>
12541254
</section>
12551255

1256+
<section title='"secret"'>
1257+
<t>
1258+
The value of this keyword MUST be a boolean. When multiple occurrences
1259+
of this keyword are applicable to a single sub-instance, the resulting
1260+
value MUST be true if any occurrence specifies a true value, and MUST
1261+
be false otherwise.
1262+
</t>
1263+
<t>
1264+
If it has value of boolean true, this keyword indicates that the value
1265+
of the instance is sensitive in nature and SHOULD NOT be displayed
1266+
except while being created. A system MAY implement this keyword as a
1267+
write-only value.
1268+
</t>
1269+
<t>
1270+
This keyword can be used to assist in user interface instance generation.
1271+
</t>
1272+
<t>
1273+
Omitting this keyword has the same behavior as a value of false.
1274+
</t>
1275+
</section>
1276+
12561277
<section title='"examples"'>
12571278
<t>
12581279
The value of this keyword MUST be an array.

0 commit comments

Comments
 (0)