Create RC2 proposal #30
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgarciahospital
requested review from
sachinvodafone and
maheshc01
as code owners
bigludo7
approved these changes
Jun 11, 2024
| CAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md). Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. | ||
| It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. | ||
|
|
||
| Population Density Data API ensures the usage of anonymized information and do not trear personal data neither as input nor output. |
There was a problem hiding this comment.
and do not treat personal data
| It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. | ||
|
|
||
| Population Density Data API ensures the usage of anonymized information and do not trear personal data neither as input nor output. | ||
| Therefore, the acceess to Population Density Data API is defined as Client Credentials - 2-legged as described in [CAMARA-API-access-and-user-consent.md - Client Credentials](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md#client-credentials) |
There was a problem hiding this comment.
Therefore, the access to
| @@ -88,6 +88,23 @@ info: | |||
| The API provides one endpoint that accepts POST requests for retrieving population | |||
| density information in the specified area. | |||
|
|
|||
| # Authorization and Authentication | |||
| CAMARA guidelines defines a set of authorization flows which can grant API clients access | |||
There was a problem hiding this comment.
There should be an additional line break between the heading and the content; otherwise, the content does not display properly in the Swagger editor.
There was a problem hiding this comment.
Apart from this, I would suggest to have examples for all three options (SUPPORTED_AREA, PART_OF_AREA_NOT_SUPPORTED, and AREA_NOT_SUPPORTED) in the response (200) example. Currently, only an example for "SUPPORTED_AREA" is provided.
There was a problem hiding this comment.
both included now in #32 , can you please confirm there to merge in this same PR?
Update population-density-data.yaml
sachinvodafone
approved these changes
Jun 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Proposing RC2 to include documentation
Which issue(s) this PR fixes:
Fixes #24