Skip to content

Create RC2 proposal#30

Merged
jgarciahospital merged 6 commits intomainfrom
release-0.1.0-rc2
Jun 19, 2024
Merged

Create RC2 proposal#30
jgarciahospital merged 6 commits intomainfrom
release-0.1.0-rc2

Conversation

@jgarciahospital
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • correction
  • documentation

What this PR does / why we need it:

Proposing RC2 to include documentation

Which issue(s) this PR fixes:

Fixes #24

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and do not treat personal data

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

solved

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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Therefore, the access to

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as new PR

density information in the specified area.

# Authorization and Authentication
CAMARA guidelines defines a set of authorization flows which can grant API clients access
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be an additional line break between the heading and the content; otherwise, the content does not display properly in the Swagger editor.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

both included now in #32 , can you please confirm there to merge in this same PR?

@jgarciahospital jgarciahospital merged commit 7f93ec7 into main Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Discussion on API access mechanism

3 participants