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

Proofread schema document vs resource for consistency and correctness. #847

Closed
handrews opened this issue Feb 5, 2020 · 4 comments
Closed
Assignees
Labels

Comments

@handrews
Copy link
Contributor

handrews commented Feb 5, 2020

It's not entirely consistent as it was a late change.

In most cases, we want to be talking about schema resources, and the root object within a schema resource. We only want to talk about documents when we mean the actual text (or octet stream, I suppose is what it technically is), no matter how many resources are contained in it.

We should also make sure that keywords confined to a root object ($schema, $recursiveAnchor, $vocabulary) are confined to the root of the correct thing. I think that should be the resource root, not the document root, even if (as is currently the case) we note that switching the $schema value within the same document does not have well-defined behavior (that's in a CREF).

@handrews handrews added the core label Feb 5, 2020
@handrews handrews added this to the draft-08-patch1 milestone Feb 5, 2020
@handrews
Copy link
Contributor Author

handrews commented May 4, 2020

We want to do this after other major work on this draft is complete, but it should be part of a holistic wording review.

@ssilverman
Copy link
Member

Looking through this now, using the following definitions:

  1. A "schema document" is the whole resource, per the "actual text" definition above, and
  2. A "schema resource" is an object having an $id.

@ssilverman
Copy link
Member

I went through every "schema document" and every "schema resource" search result and made sure they all made sense.

@Relequestual
Copy link
Member

Super. In that case, we can close out this issue! 🚀
Many thanks!

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

No branches or pull requests

3 participants