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

JSON schema uses licenseInfoInSnippets (plural) instead of licenseInfoInSnippet #804

Closed
nicoweidner opened this issue Oct 31, 2022 · 5 comments
Milestone

Comments

@nicoweidner
Copy link

I assume this is a typo: In the json schema, the property name is in plural, whereas it's singular in the spec (rdf and tagValue examples).

The singular version makes more sense, imho, since it describes the license info contained in a single snippet.

I'm happy to put up a small PR to fix this if everyone agrees it should be fixed (there may be "breaking change" considerations involved...)

@goneall
Copy link
Member

goneall commented Oct 31, 2022

@nicoweidner The schema is actually generated from the OWL Ontology using the Schema converter utility.

The utility converts any property with a cardinality allowing more than 1 to plural.

In this particular case, it should be licenseInfosInSnippet rather than licenseInfoInSnippets - however, the utility isn't smart enough to do that type of conversion.

One fix would be to special case the licenseInfoInSnippet property in the generator code. A bit hacky, but probably an OK approach.

In terms of a breaking change, it would break existing JSON files - so I'm a bit reluctant to make the change even though the change does make sense.

@nicoweidner
Copy link
Author

@goneall Thanks for the explanation (and I agree the correct plural version is hard for a tool to determine). I agree it's probably not worth it to break existing files for this change. 3.0 can fix it...

@goneall
Copy link
Member

goneall commented Nov 2, 2022

Setting a 3.0 Milestone and opening a parallel issue for the schema generator utility: spdx/tools-java#92

@seabass-labrax
Copy link
Contributor

For 3.0, we might not have licenseInfoInSnippet, as licensing information may be abstracted to artefacts in general (files, packages, snippets etc.). However, the method of representing licensing information in 3.0 is still the subject of active discussion within the Legal and Tech teams.

@goneall
Copy link
Member

goneall commented Apr 4, 2024

In 3.0 we decided to only use the singular form (even if the cardinality is more than one).

Closing this issue.

@goneall goneall closed this as completed Apr 4, 2024
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

No branches or pull requests

3 participants