Skip to content

Commit d09075c

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

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
@@ -1263,6 +1263,27 @@
12631263
</t>
12641264
</section>
12651265

1266+
<section title='"secret"'>
1267+
<t>
1268+
The value of this keyword MUST be a boolean. When multiple occurrences
1269+
of this keyword are applicable to a single sub-instance, the resulting
1270+
value MUST be true if any occurrence specifies a true value, and MUST
1271+
be false otherwise.
1272+
</t>
1273+
<t>
1274+
If it has value of boolean true, this keyword indicates that the value
1275+
of the instance is sensitive in nature and SHOULD NOT be displayed
1276+
except while being created. A system MAY implement this keyword as a
1277+
write-only value.
1278+
</t>
1279+
<t>
1280+
This keyword can be used to assist in user interface instance generation.
1281+
</t>
1282+
<t>
1283+
Omitting this keyword has the same behavior as a value of false.
1284+
</t>
1285+
</section>
1286+
12661287
<section title='"examples"'>
12671288
<t>
12681289
The value of this keyword MUST be an array.

0 commit comments

Comments
 (0)