Merge pull request #30 from camaraproject/release-0.1.0-rc2

Create RC2 proposal
camaraproject · Jun 19, 2024 · 7f93ec7 · 7f93ec7
2 parents 33e910f + 2d79b34
commit 7f93ec7
Showing 1 changed file with 78 additions and 7 deletions.
diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml
@@ -88,6 +88,24 @@ 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
+    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 access 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
 
@@ -98,7 +116,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/
@@ -168,8 +186,12 @@ paths:
                     schema:
                       $ref: '#/components/schemas/PopulationDensityResponse'
                     examples:
-                      PopulationDensityResponseExample:
-                        $ref: '#/components/examples/PopulationDensityResponseExample'
+                      PopulationDensitySupportedAreaResponseExample:
+                        $ref: '#/components/examples/PopulationDensitySupportedAreaResponseExample'
+                      PopulationDensityAreaNotSupportedResponseExample:
+                        $ref: '#/components/examples/PopulationDensityAreaNotSupportedResponseExample'
+                      PopulationDensityPartOfAreaNotSupportedResponseExample:
+                        $ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedResponseExample'   
               responses:
                 "204":
                   description: Successful notification
@@ -197,8 +219,13 @@ paths:
               schema:
                 $ref: '#/components/schemas/PopulationDensityResponse'
               examples:
-                PopulationDensityResponseExample:
-                  $ref: '#/components/examples/PopulationDensityResponseExample'
+                PopulationDensitySupportedAreaResponseExample:
+                  $ref: '#/components/examples/PopulationDensitySupportedAreaResponseExample'
+                PopulationDensityAreaNotSupportedResponseExample:
+                  $ref: '#/components/examples/PopulationDensityAreaNotSupportedResponseExample'
+                PopulationDensityPartOfAreaNotSupportedResponseExample:
+                  $ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedResponseExample'               
+
         '202':
           description: Population density data requested. This response is returned when the behaviour of the API is asynchronous.
           headers:
@@ -642,7 +669,7 @@ components:
             code: UNAVAILABLE
             message: Service unavailable
   examples:
-    PopulationDensityResponseExample:
+    PopulationDensitySupportedAreaResponseExample:
       value:
         status: SUPPORTED_AREA
         timedPopulationDensityData:
@@ -663,7 +690,7 @@ components:
                   pplDensity: 90
               - geohash: ezdqemu
                 populationDensityData:
-                  dataType: "LOW_DENSITY"
+                  dataType: LOW_DENSITY
           - startTime: "2024-01-03T11:00:00Z"
             endTime: "2024-01-03T12:00:00Z"
             cellPopulationDensityData:
@@ -685,3 +712,47 @@ components:
                   maxPplDensity: 200
                   minPplDensity: 40
                   pplDensity: 100
+    PopulationDensityPartOfAreaNotSupportedResponseExample:
+      value:
+        status: PART_OF_AREA_NOT_SUPPORTED
+        timedPopulationDensityData:
+          - startTime: "2024-01-03T10:00:00Z"
+            endTime: "2024-01-03T11:00:00Z"
+            cellPopulationDensityData:
+              - geohash: ezdqemf
+                populationDensityData:
+                  dataType: DENSITY_ESTIMATION
+                  maxPplDensity: 150
+                  minPplDensity: 30
+                  pplDensity: 60
+              - geohash: ezdqemg
+                populationDensityData:
+                  dataType: DENSITY_ESTIMATION
+                  maxPplDensity: 100
+                  minPplDensity: 40
+                  pplDensity: 90
+              - geohash: ezdqemu
+                populationDensityData:
+                  dataType: NO_DATA
+          - startTime: "2024-01-03T11:00:00Z"
+            endTime: "2024-01-03T12:00:00Z"
+            cellPopulationDensityData:
+              - geohash: ezdqemf
+                populationDensityData:
+                  dataType: DENSITY_ESTIMATION
+                  maxPplDensity: 100
+                  minPplDensity: 30
+                  pplDensity: 70
+              - geohash: ezdqemg
+                populationDensityData:
+                  dataType: DENSITY_ESTIMATION
+                  maxPplDensity: 200
+                  minPplDensity: 40
+                  pplDensity: 100
+              - geohash: ezdqemu
+                populationDensityData:
+                  dataType: NO_DATA
+    PopulationDensityAreaNotSupportedResponseExample:
+      value:
+        status: AREA_NOT_SUPPORTED
+        timedPopulationDensityData: []