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

Add glossary entries for schema and instance. #462

Merged
merged 1 commit into from
Aug 26, 2022
Merged

Conversation

Julian
Copy link
Member

@Julian Julian commented Aug 12, 2022

No description provided.

@netlify
Copy link

netlify bot commented Aug 12, 2022

Deploy Preview for condescending-hopper-c3ed30 ready!

Name Link
🔨 Latest commit 9783f12
🔍 Latest deploy log https://app.netlify.com/sites/condescending-hopper-c3ed30/deploys/62f62ea27769940008a6a5e4
😎 Deploy Preview https://deploy-preview-462--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.

@Julian
Copy link
Member Author

Julian commented Aug 26, 2022

Thanks!

@Julian Julian merged commit cdb3858 into master Aug 26, 2022
@notEthan
Copy link
Contributor

This seems to focus on validation to the point of not considering any other application of JSON schema. Validation is by far the most common thing to do with schemas and instances, for sure, but not the only thing. I'd say that an instance is JSON data described by a schema (or multiple schemas), and a schema describes a set of instances, which are expected to be valid against it.

This is a thought I have had more broadly in the language used with JSON schema. My own implementation is focused on the descriptive aspect of the schema/instance relationship, with validation being a requisite feature to support that.


A document, written according to the proscribed structure of the JSON Schema specification, which can be used to validate [instances](#instance).

The rules constituting what schemas are *valid* JSON Schemas, as well as the rules governing their behavior when validating instances, are defined by the JSON Schema specification.
Copy link
Contributor

Choose a reason for hiding this comment

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

I always feel like using the term "valid" in describing schemas that don't break any rules of the specification is asking for confusing with "valid" as a result of validating an instance against a schema. Especially since a schema can be valid against the specification, or valid against its metaschema, with pretty different (though strongly related) meanings. In that suite I'm working on of schemas that violate their spec, I landed on "conformant" to the spec to differentiate that from validation.

@Julian
Copy link
Member Author

Julian commented Aug 28, 2022

This seems to focus on validation to the point of not considering any other application of JSON schema. Validation is by far the most common thing to do with schemas and instances, for sure, but not the only thing. I'd say that an instance is JSON data described by a schema (or multiple schemas), and a schema describes a set of instances, which are expected to be valid against it.

I'm happy to reword, but don't we use the verbiage "validation" / "validate" even for the cases you're referring to? That was the feedback given here.

@Julian Julian deleted the instance-schema branch August 28, 2022 09:43
@Julian
Copy link
Member Author

Julian commented Aug 28, 2022

There's #469 with some cleanup so we can discuss on an open PR.

@handrews
Copy link
Contributor

I'm happy to reword, but don't we use the verbiage "validation" / "validate" even for the cases you're referring to? That was the feedback given here.

Which was immediately followed by:

I'd go with "evaluation." I think "apply" is also fine whether the application is because of an applicator or because of a top-level invocation, but to avoid confusion, "evaluate" is probably best (and I think we settled on evaluationPath in the revised output format?)

"evaluation" is used fairly consistently in the spec such as in section 7 among others.

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.

4 participants