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

Add clearer doc for JSON schema's default keyword #258

Closed
mothslaw opened this issue Oct 7, 2020 · 0 comments
Closed

Add clearer doc for JSON schema's default keyword #258

mothslaw opened this issue Oct 7, 2020 · 0 comments

Comments

@mothslaw
Copy link
Contributor

mothslaw commented Oct 7, 2020

Is your feature request related to a problem? Please describe.
A common misconception is that the default keyword in JSON schemas means "If the user does not supply a value for this field, then the default value will be auto-substituted". But, that's not what it means. In fact, no auto-substitution is done by the engine or anyone else. Although, our UI does, in some cases, use the {{default}} to pre-fill widgets.

Describe the solution you'd like
In the doc, we should warn plugin developers of this potential misunderstanding.

mothslaw added a commit that referenced this issue Oct 9, 2020
Fixes #258 Add clearer doc for JSON schema's default keyword
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant