Release r3.2 (Fall'25 M4)

CHANGELOG.md

@@ -2,15 +2,55 @@
 
 ## Table of Contents
 
+- **[r3.2](#r32)**
 - [r3.1](#r31)
-- **[r2.2](#r22)**
+- [r2.2](#r22)
 - [r2.1](#r21)
-- **[r1.2](#r12)**
+- [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.**
 
+# r3.2
+## Release Notes
+This public release contains the definition and documentation of
+* population-density-data v0.3.0
+
+The API definition(s) are based on
+* Commonalities v0.6.0
+* Identity and Consent Management v0.4.0
+
+## population-density-data v0.3.0
+
+This is the public release for the CAMARA Meta Release Fall25 release of the Population Density Data API, version v0.3.0. It contains mainly alignments with the Commonalities v0.6.0.
+
+- 0.3.0 Population Density Data API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r3.2/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml)
+
+In the following there is the list of the modifications with respect to the previous release.
+
+### Added
+* Alignment with Commonalities r3.3 by @albertoramosmonagas in https://github.com/camaraproject/PopulationDensityData/pull/94
+* Migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/PopulationDensityData/pull/95
+* Align with commonalities 0.6 (XCorrelator pattern update, error text clarification for generic cases) and include Sink Error by @jgarciahospital in https://github.com/camaraproject/PopulationDensityData/pull/91
+
+### Changed
+N/A
+
+### Fixed
+N/A
+
+### Removed
+N/A
+
+### New Contributors
+* @eric-murray made their first contribution in https://github.com/camaraproject/PopulationDensityData/pull/92
+
+**Full Changelog**: https://github.com/camaraproject/PopulationDensityData/compare/r2.2...r3.2
+
 # r3.1
 ## Release Notes
 
@@ -26,6 +66,8 @@ The API definition(s) are based on
 
 **population-density-data v0.3.0-rc.1 is the 1st release candidate of the version 0.3.0**
 
+This is a pre-release candidate for the CAMARA Meta Release Fall25 release of the Population Density Data API, version v0.3.0-rc.1. It contains mainly alignments with the Commonalities v0.6.0-rc.1.
+
 - 0.3.0-rc.1 Population Density Data API definition **with inline documentation**:
   - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r3.1/code/API_definitions/population-density-data.yaml)
   - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.1/code/API_definitions/population-density-data.yaml&nocors)

README.md

@@ -29,11 +29,11 @@ Incubating API Repository to evolve and maintain the definitions and documentati
 ## 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**.
-* `NEW`: Pre-release r3.1 with version 0.3.0-rc.1 of the Population Density Data API is available in [r3.1](https://github.com/camaraproject/PopulationDensityData/tree/r3.1).
-* 0.3.0-rc.1 Population Density Data API definition **with inline documentation**:
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r3.1/code/API_definitions/population-density-data.yaml)
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.1/code/API_definitions/population-density-data.yaml&nocors)
-  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.1/code/API_definitions/population-density-data.yaml)
+* **NEW**: public release of Population Density Data is [r3.2](https://github.com/camaraproject/PopulationDensityData/releases/tag/r3.2) and contains the version **0.3.0**.
+* 0.3.0 Population Density Data API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/r3.2/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.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)

code/API_definitions/population-density-data.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Population Density Data
   description: >-
-    Population Density Data API exposes population density estimations
+    The Population Density Data API exposes population density estimations
     for a specified area for a specified time interval.
 
     # Introduction
@@ -59,6 +59,8 @@ info:
 
     These values are calculated based on historical data, prediction models, and population estimation models. The requested interval must either be completely in the future or in the past.
 
+    The API has the following time constraints for requests: the minimum startTime must cover at least 3 months before the request time,
+    and the maximum endTime allowed is 3 months from the time of the request.
 
     The polygon specifying an area of interest must comply with certain restrictions,
     which must be previously validated by the developer:
@@ -131,15 +133,16 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.3.0
 
   x-camara-commonalities: 0.6
 externalDocs:
   description: Product documentation at CAMARA.
   url: https://github.com/camaraproject/PopulationDensityData
 
 servers:
-  - url: '{apiRoot}/population-density-data/vwip'
+  - url: '{apiRoot}/population-density-data/v0.3'
+
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -315,8 +318,6 @@ components:
           description: >-
             Start date time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
             and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ
-            (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
-            The minimum startTime must cover at least 3 months before the request time.
           example: "2023-07-03T12:27:08.312Z"
         endTime:
           type: string

code/Test_definitions/population-density-data.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Population Density Data API, vwip
+Feature: CAMARA Population Density Data API, v0.3.0
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -16,7 +16,7 @@ Feature: CAMARA Population Density Data API, vwip
 
   Background: Common retrievePopulationDensity setup
     Given an environment at "apiRoot"
-    And the resource "/population-density-data/vwip/retrieve"
+    And the resource "/population-density-data/v0.3/retrieve"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

documentation/API_documentation/population-density-data-API-Readiness-Checklist.md

@@ -1,19 +1,19 @@
 # API Readiness Checklist
 
-Checklist for population-density-data 0.3.0-rc.1 in release r3.1
+Checklist for population-density-data 0.3.0 in release r3.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|------|
-|  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   | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) |
-|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) |
-|  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   |  Y   | [link](/code/Test_definitions/population-density-data.feature) |
+|  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  | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y  | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y  | v0.3.0 |
+|  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  |  TBC |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y  | [link](/code/Test_definitions/population-density-data.feature) |
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |   Y  | [link](/code/Test_definitions/population-density-data.feature) |
-|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N  |      |
-| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  |      |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N  |  TBC |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  | r3.2 |
 | 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  | [link](/CHANGELOG.md) |
-| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |   N  |      |
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |   N  |  No  |
 | 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |   Y  | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/74448957/PopulationDensityData+API+description) |