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

Make IS-11 schemas self-contained #129

Merged
merged 3 commits into from
Jul 3, 2023
Merged

Conversation

garethsb
Copy link
Contributor

Would resolve #125

@garethsb garethsb requested review from alabou and N-Nagorny May 16, 2023 16:23
@garethsb
Copy link
Contributor Author

Should also remove or change the Resource-Core-Schema reference in Overview.md that currently points directly at rendered IS-04 v1.3.2 resource_core.json schema to just say that Inputs and Outputs share the same core resource attributes as IS-04 resources. After merging #131.

@N-Nagorny
Copy link
Contributor

It would be good to emphasize which IS-04 version IS-11 shares this same JSON Schema with, and something similar for BCP-004-01.

@garethsb
Copy link
Contributor Author

The interoperability section does already mention IS-04 v1.2 and state compatibility with BCP-004-01 v1.0. Maybe that's sufficient?

@N-Nagorny
Copy link
Contributor

As an implementer, I open the interoperability section to figure out dependencies, and they may be not very precise (version 1.2 or greater). As a spec maintainer, I may want to know where parts of the spec were exactly copied from. Maybe creating README.md in APIs/schemas could help?

@N-Nagorny
Copy link
Contributor

@garethsb, is it an option to add a BCP-004-01 submodule to the repo? It simplifies providing repo content to air-gapped tools, excludes possibilities for contradictions between copied and original files and resolves the issue of tracking where files were taken from.

@alabou
Copy link
Collaborator

alabou commented Jun 20, 2023

I would prefer a single instance of the schemas to prevent duplicating information. This is up to the NMOS organisation to decide of the policy for handling shared schemas ... So if the NMOS rule is to duplicate, I'm ok with that.

@N-Nagorny N-Nagorny merged commit a9e6b6b into v1.0-dev Jul 3, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should we make IS-11 schemas self contained?
3 participants