Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Add glossary entries for keyword and meta-schema. #469

Merged
merged 3 commits into from
Aug 31, 2022
Merged

Conversation

Julian
Copy link
Member

@Julian Julian commented Aug 28, 2022

Also loosens the language around schema<->instance interaction from #462 (comment).

@netlify
Copy link

netlify bot commented Aug 28, 2022

Deploy Preview for condescending-hopper-c3ed30 ready!

Name Link
🔨 Latest commit c5ecf1c
🔍 Latest deploy log https://app.netlify.com/sites/condescending-hopper-c3ed30/deploys/630e2c7a91d70b000a99c75c
😎 Deploy Preview https://deploy-preview-469--condescending-hopper-c3ed30.netlify.app/learn/glossary
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@handrews handrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

A [schema](#schema) which is itself intended to describe other *schemas*.

JSON Schema defines a language for describing any [instance](#instance) using a schema written in JSON.
Since schemas are themselves JSON values, they may be opaquely treated as *instances*, and therefore described by other schemas.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it's not entirely opaque, §9.3.3 notes that in some circumstances an alternate way of handling schema-instances SHOULD be implemented. I'm not quite sure how that should be dealt with as we don't want a huge tangent on an obscure case, but it should be acknowledged that meta-schema validation can be more complex.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you happy with deleting the word opaquely and just saying may also be treated as instances? That matches the language from §4.3.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Julian yeah that would work, thanks! Better than too much detail on the basic concept. I'll bonk the approve button again when I see that change, but feel free to consider it pre-approved - everything else is great.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, done. Thanks.

@Julian Julian merged commit 6616439 into master Aug 31, 2022
@Julian Julian deleted the keyword-meta-schema branch August 31, 2022 09:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants