Skip to content
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.

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

"secret" keyword #6

Open
handrews opened this issue Oct 18, 2017 · 2 comments
Open

"secret" keyword #6

handrews opened this issue Oct 18, 2017 · 2 comments

Comments

@handrews
Copy link
Contributor

Originally suggested by @chrisdostert in json-schema-org/json-schema-spec#249

Currently, it is more likely that a writeOnly keyword will go in the main spec, but a presentation-oriented secret keyword would also be of use on top of that. It would cover obscuring the data in form input, logs, etc.

@handrews
Copy link
Contributor Author

Reopening as the old spec repository issue had several things in it including both writeOnly and secret and was closed when the writeOnly keyword was added. secret is still a useful proposal, corresponding roughly to OpenAPI's "format": "password", except without the problem of having anything to do with format.

@underdarknl
Copy link

OpenKAT has chosen to implement a secret keyword, similar to the required keyword for the following usecase:
Some fields are secrets and should be handles as such based on the user interacting with that data. for us, Users do not have rights to see secret fields. Other users with more rights (installation admins, redteamers) do have a right to see the secrets, and if needed change them.
A WriteOnly property does not quit cover the usecase, as that would imply no-one could re-use an already present secret easily when making partial changes to the data covered by the schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants