From 5e4bef0d832e0b7f960ea020e92391a82060dcc2 Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 29 Aug 2025 12:45:21 +0200 Subject: [PATCH 01/11] Release r3.2 (Fall'25 M4) --- CHANGELOG.md | 41 ++++++++++++++++++- README.md | 10 ++--- .../population-density-data.yaml | 4 +- .../population-density-data.feature | 4 +- ...on-density-data-API-Readiness-Checklist.md | 22 +++++----- 5 files changed, 59 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index af5661d..71ec64b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,15 +2,50 @@ ## 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 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 +N/A + +### Changed +N/A + +### Fixed +N/A + +### Removed +N/A + +**Full Changelog**: https://github.com/camaraproject/PopulationDensityData/compare/r2.2...r3.2 + # r3.1 ## Release Notes @@ -26,6 +61,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) diff --git a/README.md b/README.md index d617323..e678af5 100644 --- a/README.md +++ b/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) +* The latest public release of Population Density Data is [r3.2](https://github.com/camaraproject/PopulationDensityData/releases/tag/r3.2) and cointains 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) diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml index 593778d..d86fa18 100644 --- a/code/API_definitions/population-density-data.yaml +++ b/code/API_definitions/population-density-data.yaml @@ -131,7 +131,7 @@ 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: @@ -139,7 +139,7 @@ externalDocs: url: https://github.com/camaraproject/PopulationDensityData servers: - - url: '{apiRoot}/population-density-data/vwip' + - url: '{apiRoot}/population-density-data/v0.3.0' variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/population-density-data.feature b/code/Test_definitions/population-density-data.feature index 10d287a..fd3398a 100644 --- a/code/Test_definitions/population-density-data.feature +++ b/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.0/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" diff --git a/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md b/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md index 4dd6545..aa659b3 100644 --- a/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md +++ b/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
public | stable
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.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 | 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) | From c91de33992f50df88fa47608ce961b0a93c709db Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 29 Aug 2025 14:05:35 +0200 Subject: [PATCH 02/11] add: list of changes since r3.1 to changelog --- CHANGELOG.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71ec64b..d4ebafa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,7 +33,7 @@ This is the public release for the CAMARA Meta Release Fall25 release of the Pop In the following there is the list of the modifications with respect to the previous release. ### Added -N/A +* Alignment with Commonalities r3.3 by @albertoramosmonagas in https://github.com/camaraproject/PopulationDensityData/pull/94 ### Changed N/A @@ -70,6 +70,7 @@ This is a pre-release candidate for the CAMARA Meta Release Fall25 release of th ### Added * 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 +* Migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/PopulationDensityData/pull/95 ### Changed N/A @@ -80,6 +81,9 @@ 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.1 # r2.2 From bbb234f0652eaa1a6ee53ecd20cdd38b7791072b Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 29 Aug 2025 14:06:46 +0200 Subject: [PATCH 03/11] fix: solve typo --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d4ebafa..faaf5d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ In the following there is the list of the modifications with respect to the prev ### 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 ### Changed N/A @@ -44,6 +45,9 @@ 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 @@ -70,7 +74,6 @@ This is a pre-release candidate for the CAMARA Meta Release Fall25 release of th ### Added * 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 -* Migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/PopulationDensityData/pull/95 ### Changed N/A @@ -81,9 +84,6 @@ 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.1 # r2.2 From 6a70a91daea8c016a1b545f6ab7777f71e11a410 Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 29 Aug 2025 16:33:47 +0200 Subject: [PATCH 04/11] fix: update changelog with all changes from r3.1 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index faaf5d5..476e9ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,7 @@ In the following there is the list of the modifications with respect to the prev ### 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 From 15427d8a2dcb2899a9aaf1fd4b6c471d05959075 Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 5 Sep 2025 11:48:05 +0200 Subject: [PATCH 05/11] Update CHANGELOG.md Add "public" tag to the release Co-authored-by: Kevin Smith --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 476e9ce..88d6544 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ # r3.2 ## Release Notes -This release contains the definition and documentation of +This public release contains the definition and documentation of * population-density-data v0.3.0 The API definition(s) are based on From 116dec5ef4d2ef52e623502ee01e400be607e8c9 Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 5 Sep 2025 11:51:47 +0200 Subject: [PATCH 06/11] Update README.md Co-authored-by: Kevin Smith --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e678af5..efe9b2e 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ 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**. -* The latest public release of Population Density Data is [r3.2](https://github.com/camaraproject/PopulationDensityData/releases/tag/r3.2) and cointains the version **0.3.0**. +* **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) From a9b9f9361827e7c04bb514a760d22b5ca26e13ea Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Fri, 5 Sep 2025 12:03:02 +0200 Subject: [PATCH 07/11] fix: apply commonalities and ICM release to r3.3 --- .../population-density-data-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md b/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md index aa659b3..30fe9f9 100644 --- a/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md +++ b/documentation/API_documentation/population-density-data-API-Readiness-Checklist.md @@ -5,8 +5,8 @@ Checklist for population-density-data 0.3.0 in release r3.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
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) | +| 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 | From 633dc22e63db6ccda940acdbb3b7226534f1f3ef Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Mon, 8 Sep 2025 12:17:18 +0200 Subject: [PATCH 08/11] fix: start the first sentence with the --- code/API_definitions/population-density-data.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml index 7c5c41c..8372955 100644 --- a/code/API_definitions/population-density-data.yaml +++ b/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 From ff0bec92075240d323ff35717a550753b8497b76 Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Mon, 8 Sep 2025 13:26:36 +0200 Subject: [PATCH 09/11] fix: apply L317 suggestion --- code/API_definitions/population-density-data.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml index 8372955..3911e66 100644 --- a/code/API_definitions/population-density-data.yaml +++ b/code/API_definitions/population-density-data.yaml @@ -315,8 +315,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 From 3007b253daec8cd957d82bfd51be018517a5629e Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Mon, 8 Sep 2025 14:37:07 +0200 Subject: [PATCH 10/11] fix: improve info.description --- code/API_definitions/population-density-data.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml index 3911e66..525e8b3 100644 --- a/code/API_definitions/population-density-data.yaml +++ b/code/API_definitions/population-density-data.yaml @@ -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: From d0f4ab36bb738b3412e65b47351c2eb58a46a3ab Mon Sep 17 00:00:00 2001 From: Alberto Ramos Monagas Date: Mon, 8 Sep 2025 17:21:16 +0200 Subject: [PATCH 11/11] Apply suggestions from code review Include minor version Co-authored-by: Kevin Smith --- code/API_definitions/population-density-data.yaml | 3 ++- code/Test_definitions/population-density-data.feature | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/population-density-data.yaml b/code/API_definitions/population-density-data.yaml index 525e8b3..abfa671 100644 --- a/code/API_definitions/population-density-data.yaml +++ b/code/API_definitions/population-density-data.yaml @@ -141,7 +141,8 @@ externalDocs: url: https://github.com/camaraproject/PopulationDensityData servers: - - url: '{apiRoot}/population-density-data/v0.3.0' + - url: '{apiRoot}/population-density-data/v0.3' + variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/population-density-data.feature b/code/Test_definitions/population-density-data.feature index 97620df..9d418d7 100644 --- a/code/Test_definitions/population-density-data.feature +++ b/code/Test_definitions/population-density-data.feature @@ -16,7 +16,7 @@ Feature: CAMARA Population Density Data API, v0.3.0 Background: Common retrievePopulationDensity setup Given an environment at "apiRoot" - And the resource "/population-density-data/v0.3.0/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"