simplelicensing: Change custom license additions to link to an Element #969
Conversation
JPEWdev
force-pushed
the
license-id-map-fix
branch
from
a6779b7 to
60c0763
Compare
bact
added
Profile:Core
|
Since we have to write custom code to validate a license expression anyway, is there much incremental value in having the SHACL validation of the map? In general I'm OK with the change, just wanted to make sure the change is worth the effort (e.g. I have to go back and change my current validation code). |
|
It makes it easier to ensure that they aren't complete garbage values, and also if you are linking multiple documents together it's easier if the code bindings know it's an actual object that needs to be resolved instead of just a string, you can check if its missing an external reference, etc. |
|
Discussion on call that this should be added as a new property, and other marked as depricated in 3.1. Looking for detailed review from Gary, Alexios, and others. |
|
In CHANGELOG.md, we may like to add these as well: ## Post-3.0.1 (2025-02-20)
### Changes since 3.0.1
- **Added:** `/Core/ElementMap` class - [#969](https://github.com/spdx/spdx-3-model/pull/969)
- **Added:** `/Core/elementValue` property - [#969](https://github.com/spdx/spdx-3-model/pull/969)
- **Added:** `/SimpleLicensing/customIdToLicense` property - [#969](https://github.com/spdx/spdx-3-model/pull/969)
### Deprecations since 3.0.1
- `/SimpleLicensing/customIdToUri` property - [#969](https://github.com/spdx/spdx-3-model/pull/969)
- New documents should use `/SimpleLicensing/customIdToLicense` instead. |
|
Ping @JPEWdev - Please review the above comments and rebase to the latest |
Using a DictionaryEntry to map license additions in the `customIdToUri` field has the unfortunate side effect that the dictionary entry value will not be resolve to an actual object by either SHACL or code bindings, since they are unaware that the value is supposed to be an object IRI. As such, create a new `ElementMap` object which can be used to map string keys to Elements, and use this in a new `customIdToLicense` property. The original `customIdToUri` property is retained for backward compatibility, but marked as deprecated. Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
JPEWdev
force-pushed
the
license-id-map-fix
branch
from
60c0763 to
58c15cd
Compare
| - type: xsd:string | ||
| - minCount: 1 | ||
| - maxCount: 1 | ||
| - elementValue |
There was a problem hiding this comment.
Don't we need a minCount: 1 for elementValue ?
Otherwise, what does it mean to have a key without a value?
| - maxCount: 1 | ||
| - elementValue | ||
| - type: Element | ||
| - maxCount: 1 |
There was a problem hiding this comment.
| - maxCount: 1 | |
| - minCount: 1 | |
| - maxCount: 1 |
From @zvr's comment above.
5 participants
Using a DictionaryEntry to map license additions in the
customIdToUrifield has the unfortunate side effect that the dictionary entry value will not be resolve to an actual object by either SHACL or code bindings, since they are unaware that the value is supposed to be an object IRI.As such, create a new
ElementMapobject which can be used to map string keys to Elements, and use this in a newcustomIdToLicenseproperty. The originalcustomIdToUriproperty is retained for backward compatibility, but marked as deprecated.