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.

Sign up for GitHub

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

Create RC2 proposal #30

Merged
merged 6 commits into from
Jun 19, 2024
Merged

Create RC2 proposal #30

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9db255d
Update population-density-data.yaml
jgarciahospital Jun 10, 2024
959d307
Update population-density-data.yaml
jgarciahospital Jun 10, 2024
60858b4
Merge pull request #31 from camaraproject/jgarciahospital-patch-1
jgarciahospital Jun 11, 2024
734e9ee
Update population-density-data.yaml
jgarciahospital Jun 11, 2024
976a999
Update population-density-data.yaml
jgarciahospital Jun 17, 2024
2d79b34
Merge pull request #32 from camaraproject/jgarciahospital-patch-1
jgarciahospital Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion code/API_definitions/population-density-data.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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?

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 treat
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)

# Further info and support

Expand All @@ -98,7 +115,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0-rc
version: 0.1.0-rc2
externalDocs:
description: Product documentation at Camara.
url: https://github.com/camaraproject/
Expand Down