eclipse-tractusx / digital-product-pass

digital product pass

https://github.com/eclipse-tractusx/digital-product-pass

Apache License 2.0

21 stars 11 forks source link

feat(single-api): retrieve passport data from single API call in the dpp-backend #296

Closed saudkhan116 closed 1 month ago

saudkhan116 commented 2 months ago

Why we create this PR?

To create a single API POST method that allows to retrieve the passports data by abstracting of all the API calls needed to do so. Authentication is done using the API Key method.

What we want to achieve with this PR?

The passport data should be retrieved with only one backend API call.

What is new?

Added

Added SingleApiRequest class for the requested data for the single API.
Added SingleApiConfig class to had configurations related to the single API.
Added SingleApi configuration to the main and backend helm charts in charts/digital-product-pass and dpp-backend/charts/digital-product-pass-backend
Added relevant documentaton

Updated

Updated ApiController with the singleApi POST method.
Updated ContractController by creating call methods (create, search, agree and status) without the authentication step to call in the Single API.
Updated AuthenticationService by adding the isSingleApiAuthenticated method to authenticate the single API key.
Updated application.yaml with the single api configurations.

Issue(s) Linked to:

https://github.com/eclipse-tractusx/digital-product-pass/issues/277

matbmoser commented 2 months ago

We need to test this before I can approve to merge