Typo in License() parameter spxd_license_id - should be spdx_license_id

[schlenk]

class License(builtins.object)
| License(spxd_license_id: Optional[str] = None

The parameter is prefixed by 'spxd' but the license page referenced is called "SPDX" (https://spdx.dev/)

Might be API breaking to change it.

Found in cyclonedx-python-lib 1.3.0

[jkowalleck]

Could you elaborate, @schlenk ?

What seams to be the issue? What is an acceptable solution? how would you suggest to solve the situation?

In addition, you could open a pull request to show a possible mitigation.
If you do so,

1. please read https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/CONTRIBUTING.md
2. be aware that a breaking change is already in the making - so no problem if you intend to introduce breaking changes.
   • see RELEASE 2.0.0 #148
   • you could branch out from feat/add-bom-services
     and pull request into that branch.

[schlenk]

The referenced standard is called "SPDX", so the license_id referenced in the id property and set by the constructor is a "spdx_license_id". But the constructor named parameter is called "spxd_license_id".

Calling the parameter "spxd_license_id" is confusing due to the typo (xd instead of dx) in the identifier.

If the API is broken with 2.0.0 anyway, i would simply rename the parameter to the better fitting one.

[jkowalleck]

@madpah as we are planning to have most parameters forced to be keys, this typo should be addressed.
in fact, i see it was fixed already, in

cyclonedx-python-lib/cyclonedx/model/__init__.py

Line 481 in 0d82c01

def __init__(self, *, spdx_license_id: Optional[str] = None, license_name: Optional[str] = None,

via #160

therefore i marked the relevant PRs to close this very PR, after the fact.

[madpah]

https://pypi.org/project/cyclonedx-python-lib/2.0.0/ released