Skip to content

Vocabulary definitions need not be formal or published depending on usage. #1103

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

Merged
merged 1 commit into from
Jun 1, 2021

Conversation

handrews
Copy link
Contributor

Fixes #1058. I think there is agreement on this? It was faster to write a PR than ping the issue. I'm not attached to this wording if folks prefer something else.

@handrews handrews added this to the draft-patch milestone May 14, 2021
@karenetheridge
Copy link
Member

I'd like to add that the URI used to represent the vocabulary (in the $vocabulary keyword) SHOULD resolve to a document (not a schema, but any sort of plain text document that describes the vocabulary - ranging from a freeform README right up to a formal specification), that need not be publicly be resolvable, but SHOULD be resolvable in the context where it is intended to be used -- for example, if a company develops a vocabulary for its private use, then the vocabulary URI need not be publicly available, but SHOULD be available on its own private network as a description of that vocabulary. Note "SHOULD" not "MUST" -- this is just a recommended best practice but there may be reasons why it can't be done in all circumstances.

I think this was the intent, as discussed earlier, but it never made it into the spec.

@handrews
Copy link
Contributor Author

@karenetheridge

I'd like to add that the URI used to represent the vocabulary (in the $vocabulary keyword) SHOULD resolve to a document (not a schema, but

That's outside the scope of this PR, although you're welcome to file an issue for it. The sort of wording you propose was discussed and rejected. I don't recall why (or even what side I was on), but the place to sort that out is in a new issue.

@karenetheridge
Copy link
Member

Ok, I created #1105.

@handrews handrews merged commit f42ca9f into json-schema-org:master Jun 1, 2021
@handrews handrews deleted the vocab-formality branch September 22, 2022 03:04
@gregsdennis gregsdennis added clarification Items that need to be clarified in the specification and removed Type: Maintenance labels Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification Items that need to be clarified in the specification
Development

Successfully merging this pull request may close these issues.

Degree of formality for third-party vocabularies
4 participants