Merge pull request #45 from camaraproject/jgarciahospital-patch-5

Prepare release r1.2

Author: hdamker

CHANGELOG.md

@@ -2,11 +2,51 @@
 
 ## Table of Contents
 
+- **[r1.2](#r12)**
 - [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.2
+## Release Notes
+
+This release contains the definition and documentation of
+* population-density-data v0.1.1
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+
+## population-density-data v0.1.1
+
+**population-density-data v0.1.1 is the public release of the version 0.1.1**
+
+v0.1.1 is a patch release of v0.1.0 which includes only changes of the info object in alignment with Commonalities 0.4.0, completing the alignment with Commonalities v0.4.0 and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release. Test cases are included for API validation. No new features were included.
+
+- API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r1.2/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r1.2/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.2/code/API_definitions/population-density-data.yaml)
+
+### Added
+* Include  `x-camara-commonalities` by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41
+* Include testing definitions in .feature file for Fall24 meta-release by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/44
+* Included documentation for the initial posible implementation algorithm by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/25
+* Included API test plan for Population Density Data by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/44
+
+### Changed
+* Updated Authorization and authentication section according to I&CM latest release 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
+* Align with Commonalities subscription-model by using sink and sinkCredentials by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/47
+
+### Removed
+* Remove `terms of service` and `contact` by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41
+
+
 # r1.1
 ## Release Notes
 
@@ -24,9 +64,9 @@ The API definition(s) are based on
 
 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)
+  - 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)
 
 ### Added
 * Include  `x-camara-commonalities` by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/41

README.md

@@ -30,11 +30,14 @@ 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**.
-* 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)
+* The release r1.2 contains the version 0.1.1 of the Population Density Data API. It is the release of the patch release v0.1.1. The release tag is [r1.2](https://github.com/camaraproject/PopulationDensityData/tree/r1.2).
+- 0.1.1 Population Density Data API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r1.2/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r1.2/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.2/code/API_definitions/population-density-data.yaml)
+* The latest public release is available here: https://github.com/camaraproject/PopulationDensityData/releases/latest
+* Other releases of this sub project are available in https://github.com/camaraproject/PopulationDensityData/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/PopulationDensityData/blob/main/CHANGELOG.md)
 
 ## 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>.

code/API_definitions/population-density-data.yaml

@@ -118,14 +118,14 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.1.1
 
   x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at Camara.
   url: https://github.com/camaraproject/
 servers:
-  - url: '{apiRoot}/population-density-data/vwip'
+  - url: '{apiRoot}/population-density-data/v0.1'
     variables:
       apiRoot:
         default: http://localhost:9091

documentation/API_documentation/README.MD

@@ -1,9 +1,9 @@
 # API Readiness Checklist
 
-Checklist for population-density-data 0.1.1-rc.1 in release r1.1
+Checklist for population-density-data 0.1.1 in release r1.2
 
 | 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   |      |