From 2c809271dd7071238209622cb2d1849838a2f99b Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 21 Nov 2024 12:57:53 +0100 Subject: [PATCH 01/13] Update CHANGELOG.md --- CHANGELOG.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 518a000f..9fecfa4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,32 @@ # Changelog Commonalities ## Table of Contents +- **[r2.1](#r21)** +- **[v0.4.0](#v040)** +- **[v0.4.0-rc.2](#v040-rc2)** +- **[v0.4.0-rc.1](#v040-rc1)** +- **[v0.4.0-alpha.1](#v040-alpha1)** +- **[v0.3.0](#v030)** +- **[v0.2.0](#v020)** +- **[v0.1.0 - Initial version](#v010---initial-version)** -- [v0.4.0](#v040) -- [v0.4.0-rc.2](#v040-rc2) -- [v0.4.0-rc.1](#v040-rc1) -- [v0.4.0-alpha.1](#v040-alpha1) -- [v0.3.0](#v030) -- [v0.2.0](#v020) -- [v0.1.0 - Initial version](#v010---initial-version) +# r2.1 +## Release Notes + +This release contains documents and artifacts of Commonalities version 0.5.0-alpha.1: +* Commonalities approved deliverables in **[documentation](https://github.com/camaraproject/Commonalities/tree/r2.1/documentation)** folder. +* Commonalities approved artifacts in **[artifacts](https://github.com/camaraproject/Commonalities/tree/r2.1/artifacts)** folder. + +**The relevant details of authentication and consent collection are covered by [release 2.1](https://github.com/camaraproject/IdentityAndConsentManagement/releases) of Identity and Consent Working Group documents.** + +### Added + +### Changed + +### Fixed + +### Removed # v0.4.0 From 2100e1dd6a94b294e5e52f92ed60dbb37967b05d Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:05:47 +0100 Subject: [PATCH 02/13] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb9e90f3..2c0b3bad 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,8 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- ## Status and released versions - -* Release 0.4.0 of guidelines and assets for CAMARA APIs is available with the [r0.4.0 tag](https://github.com/camaraproject/Commonalities/tree/r0.4.0): +* Alpha release of version 0.5.0 of guidelines and assets for CAMARA APIs is available with the [r2.1 tag](https://github.com/camaraproject/Commonalities/tree/r2.1) +* Release 0.4.0 of guidelines and assets for CAMARA APIs is available with the [r0.4.0 tag](https://github.com/camaraproject/Commonalities/tree/r0.4.0) * Previous releases and pre-releases are available in https://github.com/camaraproject/Commonalities/releases For changes see [CHANGELOG.md](https://github.com/camaraproject/Commonalities/blob/main/CHANGELOG.md) From 27ad2f02a20542bda5288be4f8643013ba5b63ad Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 28 Nov 2024 20:35:12 +0100 Subject: [PATCH 03/13] Update VERSION.yaml --- VERSION.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION.yaml b/VERSION.yaml index b0f22b7e..96c2e35f 100644 --- a/VERSION.yaml +++ b/VERSION.yaml @@ -1 +1 @@ -version: wip +version: 0.5.0-alpha.1 From a47885425f7675180c634c617ff638c9fed9404d Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 28 Nov 2024 20:52:04 +0100 Subject: [PATCH 04/13] Update CHANGELOG.md --- CHANGELOG.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9fecfa4b..3866d950 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,12 +21,26 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp **The relevant details of authentication and consent collection are covered by [release 2.1](https://github.com/camaraproject/IdentityAndConsentManagement/releases) of Identity and Consent Working Group documents.** ### Added +* Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in https://github.com/camaraproject/Commonalities/pull/315 +* Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/331 +* Security scheme added to CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/335 +* Add VERSION.yaml file by @rartych in https://github.com/camaraproject/Commonalities/pull/339 +* Filtering for boolean in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 ### Changed +* Normalization of error status and code allowed values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 +* Guidelines for subscription and event notification in API Design Guideliness 0.5.0 by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 + - a +* Update error codes and `info.description` template for device / phone number identifiers by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 ### Fixed +* Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333 ### Removed +N/A + +**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.1 + # v0.4.0 From 000acf9280b2d915b61c00e7dc936d716ef48aaf Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 28 Nov 2024 21:01:25 +0100 Subject: [PATCH 05/13] Update CAMARA_common.yaml --- artifacts/CAMARA_common.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/artifacts/CAMARA_common.yaml b/artifacts/CAMARA_common.yaml index 0148f79d..a42ab206 100644 --- a/artifacts/CAMARA_common.yaml +++ b/artifacts/CAMARA_common.yaml @@ -5,8 +5,8 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip - x-camara-commonalities: wip + version: 0.6.0-alpha.1 + x-camara-commonalities: 0.5.0 paths: {} components: From a50d703e9c8d0f41bb754b778cddcb1fc3e7ccb2 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 28 Nov 2024 21:02:29 +0100 Subject: [PATCH 06/13] Update event-subscription-template.yaml --- artifacts/camara-cloudevents/event-subscription-template.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/artifacts/camara-cloudevents/event-subscription-template.yaml b/artifacts/camara-cloudevents/event-subscription-template.yaml index 98769daf..02227ff6 100644 --- a/artifacts/camara-cloudevents/event-subscription-template.yaml +++ b/artifacts/camara-cloudevents/event-subscription-template.yaml @@ -11,8 +11,8 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.1.0 - x-camara-commonalities: 0.4.0 + version: 0.2.0-alpha.1 + x-camara-commonalities: 0.5.0 externalDocs: description: Product documentation at CAMARA From e6962e12f22d9f0a64cd68e6d0b73235dce7ac88 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 28 Nov 2024 21:03:29 +0100 Subject: [PATCH 07/13] Update notification-as-cloud-event.yaml --- artifacts/notification-as-cloud-event.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/artifacts/notification-as-cloud-event.yaml b/artifacts/notification-as-cloud-event.yaml index 5ed26967..fcc57766 100644 --- a/artifacts/notification-as-cloud-event.yaml +++ b/artifacts/notification-as-cloud-event.yaml @@ -42,7 +42,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.1.0 + version: 0.2.0-alpha.1 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ From 658eecb2c1f116be47e078143a5ff0187e6eb39f Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:34:46 +0100 Subject: [PATCH 08/13] Update CHANGELOG.md --- CHANGELOG.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3866d950..b9094210 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,17 +24,22 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp * Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in https://github.com/camaraproject/Commonalities/pull/315 * Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/331 * Security scheme added to CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/335 -* Add VERSION.yaml file by @rartych in https://github.com/camaraproject/Commonalities/pull/339 -* Filtering for boolean in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 +* VERSION.yaml file added to indicate Commonlities versionby @rartych in https://github.com/camaraproject/Commonalities/pull/339 +* Filtering for boolean guideline and examples in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 ### Changed * Normalization of error status and code allowed values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 -* Guidelines for subscription and event notification in API Design Guideliness 0.5.0 by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 - - a -* Update error codes and `info.description` template for device / phone number identifiers by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 +* Guidelines for subscription and event notification in API Design Guideliness 0.5.0 by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: + - updated `terminationReason` in event notification type "subscription-ends" + - updated description of `sink` and `sinkCredential` attributes for subscription + - added rules for subscriptions with device identifier attribute + - added section 11.7 Resource access restriction relevant to subscriptions + - added clarification on `expiresAt` attribute for subscription +* Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 ### Fixed * Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333 +* Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in https://github.com/camaraproject/Commonalities/pull/347 ### Removed N/A From 64c29a44eba894c18cc39cff7cd8be4dc95fcbd0 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:40:19 +0100 Subject: [PATCH 09/13] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9094210..ef34ec58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,7 +28,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp * Filtering for boolean guideline and examples in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 ### Changed -* Normalization of error status and code allowed values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 +* Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 * Guidelines for subscription and event notification in API Design Guideliness 0.5.0 by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: - updated `terminationReason` in event notification type "subscription-ends" - updated description of `sink` and `sinkCredential` attributes for subscription From 2ba8281034c3afdcf2a7a28fa59ee3668bf6ed60 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 29 Nov 2024 20:29:56 +0100 Subject: [PATCH 10/13] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ef34ec58..696f8e5f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp * Security scheme added to CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/335 * VERSION.yaml file added to indicate Commonlities versionby @rartych in https://github.com/camaraproject/Commonalities/pull/339 * Filtering for boolean guideline and examples in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 +* Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in https://github.com/camaraproject/Commonalities/pull/343 ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 @@ -36,6 +37,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp - added section 11.7 Resource access restriction relevant to subscriptions - added clarification on `expiresAt` attribute for subscription * Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 +* ### Fixed * Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333 From 2f7122337ce60b6a690e548cec77b885e591fd20 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 3 Dec 2024 16:38:17 +0100 Subject: [PATCH 11/13] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 696f8e5f..87c50d2a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,7 +37,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp - added section 11.7 Resource access restriction relevant to subscriptions - added clarification on `expiresAt` attribute for subscription * Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 -* +* Guidelines regarding mandatory error `status` and alignment of error codes related to identifiers in API Design Guideliness by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 ### Fixed * Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333 From acfbc56e8025ea10b4294f310a79637c2ecd0503 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 5 Dec 2024 09:14:30 +0100 Subject: [PATCH 12/13] Update CHANGELOG.md Fixed typos and suggestions Added https://github.com/camaraproject/Commonalities/pull/351 --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 87c50d2a..8471f49d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,20 +24,20 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp * Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in https://github.com/camaraproject/Commonalities/pull/315 * Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/331 * Security scheme added to CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/335 -* VERSION.yaml file added to indicate Commonlities versionby @rartych in https://github.com/camaraproject/Commonalities/pull/339 +* VERSION.yaml file added to indicate Commonalities version by @rartych in https://github.com/camaraproject/Commonalities/pull/339 * Filtering for boolean guideline and examples in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336 * Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in https://github.com/camaraproject/Commonalities/pull/343 ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 -* Guidelines for subscription and event notification in API Design Guideliness 0.5.0 by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: +* Guidelines for subscription and event notification in API Design Guideliness by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: - updated `terminationReason` in event notification type "subscription-ends" - updated description of `sink` and `sinkCredential` attributes for subscription - added rules for subscriptions with device identifier attribute - added section 11.7 Resource access restriction relevant to subscriptions - added clarification on `expiresAt` attribute for subscription -* Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 -* Guidelines regarding mandatory error `status` and alignment of error codes related to identifiers in API Design Guideliness by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 +* Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 and https://github.com/camaraproject/Commonalities/pull/346 +* Guidelines regarding mandatory error `status` and alignment of error codes related to identifiers in API Design Guideliness by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 ### Fixed * Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333 From 3ad4b95d741de466a267fadb7af4c645d79ddc30 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 5 Dec 2024 20:20:49 +0100 Subject: [PATCH 13/13] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pedro Díez García --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8471f49d..8a124114 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,14 +30,14 @@ This release contains documents and artifacts of Commonalities version 0.5.0-alp ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 -* Guidelines for subscription and event notification in API Design Guideliness by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: +* Guidelines for subscription and event notification in API Design Guidelines by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes: - updated `terminationReason` in event notification type "subscription-ends" - updated description of `sink` and `sinkCredential` attributes for subscription - added rules for subscriptions with device identifier attribute - added section 11.7 Resource access restriction relevant to subscriptions - added clarification on `expiresAt` attribute for subscription * Updated error codes and changed `info.description` template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in https://github.com/camaraproject/Commonalities/pull/324 and https://github.com/camaraproject/Commonalities/pull/346 -* Guidelines regarding mandatory error `status` and alignment of error codes related to identifiers in API Design Guideliness by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 +* Guidelines regarding mandatory error `status` and alignment of error codes related to identifiers in API Design Guidelines by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 ### Fixed * Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333