feat(api): Update Upload Summary API to add more info

[dushimsam]

Description

Update the current API to for getting the upload's summary to add more information related to licenses.

Changes

1. Updated the method getUploadSummary in UploadController to make the changes.
2. Updated the openapi.yaml file to introduce a new changes for the API.

How to test

Make a GET request on the endpoint: /uploads/{id}/summary.

Screenshots

Related Issue:

Fixes #2467

cc: @shaheemazmalmmd @GMishx

[github-actions]

This pull request has conflicts, please rebase with master to resolve those before we can evaluate the pull request.

[GMishx]

Would recommend extending existing endpoint /uploads/{id}/summary as it already contains most of the required information.

fossology/src/www/ui/api/documentation/openapi.yaml

Line 592 in 2c8522e

/uploads/{id}/summary:

Existing endpoint of left, new endpoint on the right.

[dushimsam]

Would recommend extending existing endpoint /uploads/{id}/summary as it already contains most of the required information.

fossology/src/www/ui/api/documentation/openapi.yaml

Line 592 in 2c8522e

/uploads/{id}/summary:

Existing endpoint of left, new endpoint on the right.

Yes, that looks better.

[dushimsam]

But again @GMishx, The new API only returns the summary of upload for the licenses section, not for other modules like copyrights. The values returned by the new API also vary depending on the agentId selected. Given these factors, do you think it is appropriate to include them in the existing implementation? Let me know what you think and then I will go with your suggestion. Thank you.

[GMishx]

Oh, I didn't notice the endpoint is dependent on agent id. But still, they can be merged if the agent id is not provided, the current behavior can be followed. Otherwise, the values will change based on agent id.

It is better to send little more information from a single endpoint than creating one more which shares the same info. Creating new endpoint will also cause confusion if more than 1 endpoint can be used to get same info (and will also need multiple calls if info from both endpoint is needed :-))

[dushimsam]

Awesome, I have applied the new changes to the current implementation and have revised the commit and the PR's description.
Please let me know if there is anything else I need to modify.

Thank you very much.

[GMishx]

Changes looks good.
Tested, working as expected.