Merge pull request #41 from camaraproject/jgarciahospital-patch-3

hdamker · web-flow · commit 7232a5210cb8 · 2024-08-02T13:11:10.000+02:00
Prepare release r1.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,45 @@
 
 ## Table of Contents
 
+- [r1.1](#r11)
 - [v0.1.0](#v010)
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
 
+# r1.1
+## Release Notes
+
+This release contains the definition and documentation of
+* population-density-data v0.1.1-rc.1
+
+The API definition(s) are based on
+* Commonalities v0.4.0-rc.1
+* Identity and Consent Management v0.2.0-rc.1
+
+
+## population-density-data v0.1.1-rc.1
+
+**population-density-data v0.1.1-rc.1 is the 1st release candidate of the version 0.1.1**
+
+v0.1.1 will be a patch release of v0.1.0 which includes only changes of the info object in alignment with Commonalities 0.4.0.
+- API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/release-v0.1.1-rc1.1/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.1-rc1.1/code/API_definitions/population-density-data.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.1-rc1.1/code/API_definitions/population-density-data.yaml)
+
+### Added
+* Include  `x-camara-commonalities` by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41
+
+### Changed
+* Updated Authorization and authentication section according to I&CM last release (v0.2.0-rc1) by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41
+* Updated API and error descriptions by @gregory1g in https://github.com/camaraproject/PopulationDensityData/pull/42
+
+### Fixed
+
+### Removed
+* Remove `terms of service` and `contact` by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41
+
+
 # v0.1.0
 
 **This is the first alpha version of the Population Density Data API.** 
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ Repository to describe, develop, document and test the Population Density Data A
 ## Status and released versions
 
 * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
-* Release 0.1.0 of the API family is available within the [release-v0.1.0](https://github.com/camaraproject/PopulationDensityData/tree/release-v0.1.0) branch.
-- 0.1.0 Population Density Data API definition **with inline documentation**:
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/release-v0.1.0/code/API_definitions/population-density-data.yaml)
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.0/code/API_definitions/population-density-data.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.0/code/API_definitions/population-density-data.yaml)
+* The pre-release r1.1 contains the version 0.1.1-rc.1 of the Population Density Data API. It is the first release candidate of the patch release v0.1.1. The release tag is [r1.1](https://github.com/camaraproject/PopulationDensityData/tree/r1.1).
+- 0.1.1-rc.1 Population Density Data API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r1.1/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r1.1/code/API_definitions/population-density-data.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r1.1/code/API_definitions/population-density-data.yaml)
 
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-pdd>.
diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml
@@ -94,37 +94,31 @@ info:
 
     # 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 is determined during
-    onboarding process, happening between the API Client and the MNO 
-    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)
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
+
+    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. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow.
+
 
     # Further info and support
 
-  termsOfService: http://swagger.io/terms/
-  contact:
-    email: project-email@sample.com
+    (FAQs will be added in a later version of the documentation)
+
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.1.0
+  version: 0.1.1-rc.1
+
+  x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at Camara.
   url: https://github.com/camaraproject/
 servers:
-  - url: '{apiRoot}/population-density-data/v0.1'
+  - url: '{apiRoot}/population-density-data/v0.1rc1'
     variables:
       apiRoot:
         default: http://localhost:9091
diff --git a/documentation/API_documentation/Population-Density-Data-API-Readiness-Checklist.md b/documentation/API_documentation/Population-Density-Data-API-Readiness-Checklist.md
@@ -0,0 +1,18 @@
+# API Readiness Checklist
+
+Checklist for population-density-data 0.1.1-rc.1 in release r1.1
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/population-density-data.yaml) |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   |      |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   |      |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |  Y   |      |
+|  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | Embed documentation into API spec - [link](/code/API_definitions/population-density-data.yaml) |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   |      |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Pending   |  |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |   N  |  |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N  |  |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  |      |
+| 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  | [link](/CHANGELOG.md) |
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |   N  |      |
