spdx-spec icon indicating copy to clipboard operation
spdx-spec copied to clipboard

Incompatibility in comment property for license between JSON and RDF/XML

Open goneall opened this issue 5 years ago • 4 comments

We are using JSON formats for the SPDX listed licenses in addition to the RDF/XML formats.

In RDF/XML we use the property name comment with the RDFS namespace.

The JSON file uses licenseComment.

For examples, see the Apache JSONLD file for the RDF definition and the straight JSON file for the JSON definition.

These fields should be consistent.

goneall avatar Nov 20 '19 18:11 goneall

Propose using comment. Shorter, more consistent with other JSON classes as well as consistent with the RDF.

goneall avatar Nov 20 '19 18:11 goneall

Since fixing this will break something, proposing we address this in SPDX 3.0.

goneall avatar Nov 20 '19 18:11 goneall

Based on call today, this can be fixed for the spec in 2.2, but the license list will be inconsistent and that will be addressed in 3.0

kestewart avatar Nov 26 '19 18:11 kestewart

Based on call, we will use comment for JSON in 2.2, and make XML compatible in future release. So no change in 2.2 Specification, and we'll resolve in 3.0. Should this be moved to license list XML repo or License list publisher? Will give more visibility to JSON user files.

kestewart avatar Mar 17 '20 17:03 kestewart

This is resolved in 3.0 - closing

goneall avatar Apr 04 '24 17:04 goneall