Skip to content

Add a "writeOnly" (formerly "secret") annotation #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
handrews merged 3 commits into from
Oct 20, 2017
Merged

Add a "writeOnly" (formerly "secret") annotation #433

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d09075c
Add a "secret" annotation
handrews Oct 8, 2017
b915592
Use "writeOnly" instead of "secret"
handrews Oct 18, 2017
8a368ed
Add "writeOnly" to changelog
handrews Oct 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions jsonschema-validation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1238,28 +1238,49 @@
</t>
</section>

<section title='"readOnly"'>
<section title='"readOnly" and "writeOnly"'>
<t>
The value of this keyword MUST be a boolean. When multiple occurrences
of this keyword are applicable to a single sub-instance, the resulting
The value of these keywords MUST be a boolean. When multiple occurrences
of these keywords are applicable to a single sub-instance, the resulting
value MUST be true if any occurrence specifies a true value, and MUST
be false otherwise.
</t>
<t>
If it has a value of boolean true, this keyword indicates that the value
If "readOnly" has a value of boolean true, it indicates that the value
of the instance is managed exclusively by the owning authority, and
attempts by an application to modify the value of this property are
expected to be ignored or rejected by that owning authority.
</t>
<t>
For example, this property would be used to mark a database-generated serial
number as read-only.
An instance document that is marked as "readOnly for the entire document
MAY be ignored if sent to the owning authority, or MAY result in an
error, at the authority's discretion.
</t>
<t>
This keyword can be used to assist in user interface instance generation.
If "writeOnly" has a value of boolean true, it indicates that the value
is never present when the instance is retrieved from the owning authority.
It can be present when sent to the owning authority to update or create
the document (or the resource it represents), but it will not be included
in any updated or newly created version of the instance.
</t>
<t>
Omitting this keyword has the same behavior as a value of false.
An instance document that is marked as "writeOnly" for the entire document
MAY be returned as a blank document of some sort, or MAY produce an error
upon retrieval, or have the retrieval request ignored, at the authority's
discretion.
</t>
<t>
For example, "readOnly" would be used to mark a database-generated serial
number as read-only, while "writeOnly" would be used to mark a password
input field.
</t>
<t>
These keywords can be used to assist in user interface instance generation.
In particular, an application MAY choose to use a widget that hides
input values as they are typed for write-only fields.
</t>
<t>
Omitting these keywords has the same behavior as values of false.
</t>
</section>

Expand Down Expand Up @@ -1387,6 +1408,7 @@
<t>Warn of possibly removing "dependencies" in the future</t>
<t>Grouped validation keywords into sub-sections for readability</t>
<t>Moved "readOnly" from hyper-schema to validation meta-data</t>
<t>Added "writeOnly"</t>
<t>Added string-encoded media section, with former hyper-schema "media" keywords</t>
<t>Restored "regex" format (removal was unintentional)</t>
<t>Added "date" and "time" formats, and reserved additional RFC 3339 format names</t>
Expand Down