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

Need an endpoint to get the license findings in a package #2074

Open
Etsija opened this issue Feb 20, 2025 · 3 comments
Open

Need an endpoint to get the license findings in a package #2074

Etsija opened this issue Feb 20, 2025 · 3 comments
Labels
api Issues related to the API.

Comments

@Etsija
Copy link
Contributor

Etsija commented Feb 20, 2025

Either a dedicated endpoint for this is needed, or then this endpoint needs to be extended to provide with the detected licenses (which are available after the Scanner job is completed).

@Etsija Etsija added the api Issues related to the API. label Feb 20, 2025
@mnonnenmacher
Copy link
Contributor

mnonnenmacher commented Feb 20, 2025

@Etsija Do you mean just the detected license as one SPDX expression, or the list of license findings?

If the latter, this should be a separate endpoint to properly support pagination.
Should the returned data also include any applied license finding curations or path excludes? For the user it would be very helpful to show this information.

@Etsija Etsija changed the title Need an endpoint to get the detected licenses in a package Need an endpoint to get the license findings in a package Feb 21, 2025
@Etsija
Copy link
Contributor Author

Etsija commented Feb 21, 2025

Some thoughts:

  • yes, the list of license findings, which we would display alongside the declared licenses column, to easily identify discrepancies
  • do you really think it would need a separate paginated endpoint? Are we expecting the list to be very long, potentially?
  • as for the license finding curations and path excludes, I'd like to involve @sschuberth in the discussion, as I believe that would tie the retrieval of this data to the Evaluator/PackageConfigurationProvider and alter the original use case we had in mind

@sschuberth
Copy link
Contributor

do you really think it would need a separate paginated endpoint? Are we expecting the list to be very long, potentially?

Yes and yes, but IIUC that question referred to the case of having a dedicated license findings (which we probably want to have, I means it's already there but empty; however, that's a slightly different topic of displaying detected licenses as part of the packages view).

Should the returned data also include any applied license finding curations or path excludes?

I believe at least the dedicated license findings view should optionally take them into account (which reminds me a bit of #2071, BTW). But also for the display of detect licenses in the packages view it should be the case, I believe.

@mnonnenmacher, I propose to have a short meeting to discuss the details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues related to the API.
Projects
None yet
Development

No branches or pull requests

3 participants