-
Notifications
You must be signed in to change notification settings - Fork 6
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
Rationale for schema "$id" URI values? #26
Comments
The only idea behind the URI was uniqueness within a single version, but I am happy to start the discussion to change to something resolvable. |
Personally I don't see the need for the
Sorry, that's not what I meant. None of IS-04, IS-05, IS-06 and IS-08, use |
I found it impossible to validate referenced schemas (in a folder) without the $id, at least with the tool I was using (Ajv: Another JSON Schema Validator) - without the ids the tool is not able to distinguish between the schemas. Again, I like the idea of using the URNs if possible so we might refactor this. The good thing is that it isn't a breaking change so should be doable easily... |
In my experience, not all implementations fully support the specification for structuring a complex JSON schema into multiple files using The Understanding JSON Schema 'book' guide to Structuring a complex schema - The $id property suggests that "it is best practice that every top-level schema should set However, I think we should be consistent between all AMWA IS of NMOS, shouldn't we? So this is probably another 'NMOS Core' issue for the incubator. |
I would agree that is something to bring up at the NMOS Core. I don't think this is an urgent matter (to be done in the next week or so) as it works for now... |
Needs clarification on the NMOS level, perhaps under NMOS Core |
Discussed in ARG call, 7 July 2023, because schema |
Unlike IS-04, IS-05, IS-06 and IS-08, schemas in this repo have
"$id"
values.These values may be useful, but I wonder why the particular URL has been used?
While there is no requirement that the URI given as a
"$id"
is resolvable, the URLs used, likehttps://www.amwa.tv/event_and_tally/base.json might be expected to be resolvable, but result in
404 Not Found
.It seems strange to have used a non-resolvable URL rather than either a URN (e.g.
urn:nmos:...
as in several other NMOS specs) or a nice resolvable URL (such as https://github.com/AMWA-TV/nmos-event-tally/raw/v1.0/APIs/schemas/base.json).The current non-resolvable URL, rendering 'NMOS Event & Tally' as
event_and_tally
fails to follow the naming used elsewhere likenmos-event-tally
and are unversioned, which must be an oversight?The text was updated successfully, but these errors were encountered: