Add a glossary entry for JSON. #521
Conversation
✅ Deploy Preview for condescending-hopper-c3ed30 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
learn/glossary.md
Outdated
| JSON Schema, distinctly, is built *on top* of JSON, in that JSON [schemas](#schema) are themselves JSON objects which describe other JSON objects. | ||
| The two are, however, entirely different pieces of the conceptual puzzle, with JSON being a concrete format for *representing* data and JSON Schema being a way to *schematize* data which is written in the JSON format. |
There was a problem hiding this comment.
I think something we want to convey in a glossary entry for JSON is that JSON Schema doesn't require that your schemas or instances are JSON, just that they are compatible with JSON. I think the current wording implies a tighter connection to JSON than is currently accurate.
There was a problem hiding this comment.
That's mentioned in the entry for schemas below on the page -- think we should repeat it here as well?
There was a problem hiding this comment.
I don't think we need to give a full explanation like below, but I think adding some qualifiers would help. I think people don't generally read a glossary top to bottom, they jump around to the terms they don't know. So, we can't assume they read other parts.
Example: "which is written in the JSON format" => "which is written in a JSON-compatible format".
Co-authored-by: Jason Desrosiers <[email protected]>
|
Thanks, applied both suggestions I think! |
Refs: json-schema-org/community#199