Add more details to upgrade docs #318
Conversation
|
|
||
| ## Removed methods | ||
|
|
||
| Some methods that exist in the v2.3 model classes (e.g. `org.spdx.library.model.license.SpdxListedLicense.getLicenseTextHtml()`, `org.spdx.library.model.license.SpdxListedLicense.getCrossRef()`, `org.spdx.library.model.license.ListedLicenseException.getExceptionTextHtml()`) have been removed and do not have an equivalent in the v3.0 model classes. |
There was a problem hiding this comment.
@goneall please confirm that this is true. I couldn't find where these methods went, but I'm not 100% sure they don't in fact exist somewhere in one of the other new libraries.
There was a problem hiding this comment.
This is true - the SPDX 3 specification does not define these three fields.
A bit of background - the 3 fields were added to the SPDX 2 model to enable the license list publisher to use the standard model for publishing. The 3 fields never made it into the spec, however. In hindsight, we probably should have created a subclass of listed license to store the additional fields - but I don't want to implement something that may break compatibility.
@zvr @swinslow - do you see any value of adding the information used to generate the license website to the actual listed license model? If so, we can propose adding them back to the SPDX 3 model.
This PR adds more details to the upgrade docs, based on my preliminary work upgrading clj-spdx to v2.0.0 of the library. Note that some of these details may be incorrect, as I've found it difficult to find where some functionality has gone, given issue #317 and associated issues.