From 9b3942f4315f23536eb0dd294bf6b0fbe3404364 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 9 Jan 2025 11:39:27 +0100 Subject: [PATCH 01/19] Update CHANGELOG.md --- CHANGELOG.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a124114..d71fc57c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog Commonalities ## Table of Contents +- **[r2.2](#r22)** - **[r2.1](#r21)** - **[v0.4.0](#v040)** - **[v0.4.0-rc.2](#v040-rc2)** @@ -10,6 +11,53 @@ - **[v0.2.0](#v020)** - **[v0.1.0 - Initial version](#v010---initial-version)** +# r2.2 +## Release Notes + +This release contains documents and artifacts of Commonalities version 0.5.0-rc.1: +* Commonalities approved deliverables in **[documentation](https://github.com/camaraproject/Commonalities/tree/r2.2/documentation)** folder. +* Commonalities approved artifacts in **[artifacts](https://github.com/camaraproject/Commonalities/tree/r2.2/artifacts)** folder. + +**The relevant details of authentication and consent collection are covered by [release 2.2](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 +* 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 +* Common artifacts for testing error scenarios for device and phoneNumber by @jlurien in https://github.com/camaraproject/Commonalities/pull/325 +* String format/pattern recommendation by @rartych in https://github.com/camaraproject/Commonalities/pull/330 +* Enum values for `terminationReason` attribute in the guideline document by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/356 +* Created API-cheatsheet.md by @Kevsy in https://github.com/camaraproject/Commonalities/pull/320 +* Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292 + + +### 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 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 Guidelines by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 +* Updated linting rules by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/337 and https://github.com/camaraproject/Commonalities/pull/367 +* Updated rules when using POST for sensitive data by @eric-murray in https://github.com/camaraproject/Commonalities/pull/358 + + +### 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 +* Corrected CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines by @eric-murray in https://github.com/camaraproject/Commonalities/pull/359 +* Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/361 + +### Removed +N/A + +**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.2 # r2.1 ## Release Notes From 4c32318871bae23819fd4a044a92a10602e0e9e3 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 9 Jan 2025 13:10:32 +0100 Subject: [PATCH 02/19] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d71fc57c..ee8c5e67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,6 +32,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * Enum values for `terminationReason` attribute in the guideline document by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/356 * Created API-cheatsheet.md by @Kevsy in https://github.com/camaraproject/Commonalities/pull/320 * Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292 +* ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/364 ### Changed From 2a2ea2d43d4b5c92b8887871e65b9d92e2218e9d Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:55:13 +0100 Subject: [PATCH 03/19] Update CHANGELOG.md --- CHANGELOG.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ee8c5e67..4e3c7a0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,13 +27,13 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * 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 -* Common artifacts for testing error scenarios for device and phoneNumber by @jlurien in https://github.com/camaraproject/Commonalities/pull/325 +* Common artifacts for testing error scenarios for device and phoneNumber by @jlurien in https://github.com/camaraproject/Commonalities/pull/325 https://github.com/camaraproject/Commonalities/pull/381 and https://github.com/camaraproject/Commonalities/pull/386 * String format/pattern recommendation by @rartych in https://github.com/camaraproject/Commonalities/pull/330 * Enum values for `terminationReason` attribute in the guideline document by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/356 * Created API-cheatsheet.md by @Kevsy in https://github.com/camaraproject/Commonalities/pull/320 * Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292 * ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/364 - +* String pattern added to x-correlator scheme by @rartych in https://github.com/camaraproject/Commonalities/pull/373 and https://github.com/camaraproject/Commonalities/pull/387 ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 @@ -47,14 +47,15 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * 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 * Updated linting rules by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/337 and https://github.com/camaraproject/Commonalities/pull/367 * Updated rules when using POST for sensitive data by @eric-murray in https://github.com/camaraproject/Commonalities/pull/358 - +* Changed guidelines on `x-camara-commonalities` extension field by @rartych in https://github.com/camaraproject/Commonalities/pull/375 ### 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 * Corrected CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines by @eric-murray in https://github.com/camaraproject/Commonalities/pull/359 * Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/361 - +* Note on support for networkAccessIdentifier in CAMARA_common.yaml by @jlurien in https://github.com/camaraproject/Commonalities/pull/379 + ### Removed N/A From 679dec66e3c44742e9af6f8b7589381801085be1 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:56:21 +0100 Subject: [PATCH 04/19] 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 d93ee246..ff68fc6e 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.2.0-alpha.1 + version: 0.2.0-rc.1 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ From b4a9ad40ecb85973b19e0cb13bd13f7e50306b4f Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:57:51 +0100 Subject: [PATCH 05/19] Update CAMARA_common.yaml --- artifacts/CAMARA_common.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/artifacts/CAMARA_common.yaml b/artifacts/CAMARA_common.yaml index bf40bf14..a76919a9 100644 --- a/artifacts/CAMARA_common.yaml +++ b/artifacts/CAMARA_common.yaml @@ -5,7 +5,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.6.0-rc.1 x-camara-commonalities: 0.5 paths: {} From 5f319c1e796eedf106a2dbcbced244996b6bf3d3 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:59:00 +0100 Subject: [PATCH 06/19] Update event-subscription-template.yaml --- artifacts/camara-cloudevents/event-subscription-template.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/artifacts/camara-cloudevents/event-subscription-template.yaml b/artifacts/camara-cloudevents/event-subscription-template.yaml index f63890af..c2394711 100644 --- a/artifacts/camara-cloudevents/event-subscription-template.yaml +++ b/artifacts/camara-cloudevents/event-subscription-template.yaml @@ -11,7 +11,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.2.0-alpha.1 + version: 0.2.0-rc.1 x-camara-commonalities: 0.5 externalDocs: From 7bc29498426ba8eb333f7bcb0e59b77d6c942292 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 17:00:40 +0100 Subject: [PATCH 07/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c0b3bad..10a1c791 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- ## Status and released versions -* 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 Candidate of version 0.5.0 of guidelines and assets for CAMARA APIs is available with the [r2.2 tag](https://github.com/camaraproject/Commonalities/tree/r2.2) * 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 From 187bfee117199fa5a48bebebf326d3991261048b Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 17:03:33 +0100 Subject: [PATCH 08/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10a1c791..ae3667d9 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ For changes see [CHANGELOG.md](https://github.com/camaraproject/Commonalities/bl ## Meetings * Meetings are held virtually on the LF Platform: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91016460698?password=d031b0e3-8d49-49ae-958f-af3213b1e547) -* Schedule: bi-weekly, Monday, 4 PM CET/CEST (3 PM BST, 15:00 UTC). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/Fzje). +* Schedule: bi-weekly, Monday, 15:00 UTC CET/CEST (4 PM CET / 5 PM CEST). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/Fzje). ## Contributorship and mailing list From 62d7f3620cce76689b33292fb5fa2aabc1a73984 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 19:38:30 +0100 Subject: [PATCH 09/19] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae3667d9..3c47676c 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ The `artifacts` directory contains: * common data and error formats for CAMARA APIs in [CAMARA_common.yaml](artifacts/CAMARA_common.yaml) * notification subscription template: [event-subscription-template.yaml](artifacts/camara-cloudevents/event-subscription-template.yaml) * OAS definition of CAMARA Event using CloudEvents: [notification-as-cloud-event.yaml](artifacts/notification-as-cloud-event.yaml) +* Common artifacts for testing error scenarios for device and phoneNumber: in [artifacts/testing](artifacts/testing) folder ### Frequently-accessed output documents @@ -35,6 +36,7 @@ A list of some of the frequently accessed documents that are an output of the wo | [API-design-guidelines.md](documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | | [Glossary.md](documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs | | [API-Testing-Guidelines.md](documentation/API-Testing-Guidelines.md) | Guidelines for the API testing in CAMARA project | +| [API-cheatsheet.md](documentation/API-cheatsheet.md) | CAMARA syntax cheatsheet | NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-Checklist, are located within [ReleaseManagement](https://github.com/camaraproject/ReleaseManagement). The versioning of APIs is defined within the [API-design-guidelines.md](documentation/API-design-guidelines.md#5-versioning). @@ -48,7 +50,7 @@ For changes see [CHANGELOG.md](https://github.com/camaraproject/Commonalities/bl ## Meetings * Meetings are held virtually on the LF Platform: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91016460698?password=d031b0e3-8d49-49ae-958f-af3213b1e547) -* Schedule: bi-weekly, Monday, 15:00 UTC CET/CEST (4 PM CET / 5 PM CEST). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/Fzje). +* Schedule: bi-weekly, Monday, 15:00 UTC CET/CEST (4 PM CET / 5 PM CEST). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/2AD7Aw). ## Contributorship and mailing list From 277468f224733d9115b2d8d6960849f5c53bc0fd Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 21 Jan 2025 19:39:06 +0100 Subject: [PATCH 10/19] Update VERSION.yaml --- VERSION.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION.yaml b/VERSION.yaml index 96c2e35f..ec180725 100644 --- a/VERSION.yaml +++ b/VERSION.yaml @@ -1 +1 @@ -version: 0.5.0-alpha.1 +version: 0.5.0-rc.1 From 89d4165a4bde157899286baaa64b0a4df683783c Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:11:09 +0100 Subject: [PATCH 11/19] Update CHANGELOG.md --- CHANGELOG.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e3c7a0f..bb6fd2b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,7 +33,8 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * Created API-cheatsheet.md by @Kevsy in https://github.com/camaraproject/Commonalities/pull/320 * Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292 * ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/364 -* String pattern added to x-correlator scheme by @rartych in https://github.com/camaraproject/Commonalities/pull/373 and https://github.com/camaraproject/Commonalities/pull/387 +* String pattern added to x-correlator scheme by @rartych in https://github.com/camaraproject/Commonalities/pull/373 and updated in https://github.com/camaraproject/Commonalities/pull/387 +* ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 @@ -45,6 +46,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. - 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 Guidelines by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 +* Guidelines on non-mandatory error statuses, 429 made non-madatory and special considerations for 501 by @rartych in https://github.com/camaraproject/Commonalities/pull/374 * Updated linting rules by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/337 and https://github.com/camaraproject/Commonalities/pull/367 * Updated rules when using POST for sensitive data by @eric-murray in https://github.com/camaraproject/Commonalities/pull/358 * Changed guidelines on `x-camara-commonalities` extension field by @rartych in https://github.com/camaraproject/Commonalities/pull/375 @@ -55,6 +57,8 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * Corrected CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines by @eric-murray in https://github.com/camaraproject/Commonalities/pull/359 * Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/361 * Note on support for networkAccessIdentifier in CAMARA_common.yaml by @jlurien in https://github.com/camaraproject/Commonalities/pull/379 +* Improved 403 INVALID_TOKEN_CONTEXT scope/description by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/377 +* Updated message field and description for Error 429 by @rartych in https://github.com/camaraproject/Commonalities/pull/390 ### Removed N/A From 6083423b9bebaf9c6dc08576a9c962bd73d961ad Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:12:54 +0100 Subject: [PATCH 12/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c47676c..b20adcd4 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- * 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) +For changes see [CHANGELOG.md](CHANGELOG.md) ## Meetings * Meetings are held virtually on the LF Platform: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91016460698?password=d031b0e3-8d49-49ae-958f-af3213b1e547) From 1a750f3e7ee6c8272c2a4ebadc80f86dec4b9c10 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:19:32 +0100 Subject: [PATCH 13/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b20adcd4..5e3f958a 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ For changes see [CHANGELOG.md](CHANGELOG.md) ## Meetings * Meetings are held virtually on the LF Platform: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91016460698?password=d031b0e3-8d49-49ae-958f-af3213b1e547) -* Schedule: bi-weekly, Monday, 15:00 UTC CET/CEST (4 PM CET / 5 PM CEST). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/2AD7Aw). +* Schedule: bi-weekly, Monday, 15:00 UTC (4 PM CET / 5 PM CEST). The date of the next meeting can be found in the previous [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/2AD7Aw). ## Contributorship and mailing list From 09231be7456f578681e6f6a3652c5efc157a097d Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:20:36 +0100 Subject: [PATCH 14/19] Update CHANGELOG.md 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 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb6fd2b7..daee751e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,7 +46,7 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. - 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 Guidelines by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/329 and https://github.com/camaraproject/Commonalities/pull/351 -* Guidelines on non-mandatory error statuses, 429 made non-madatory and special considerations for 501 by @rartych in https://github.com/camaraproject/Commonalities/pull/374 +* Guidelines on non-mandatory error statuses, 429 made non-mandatory and special considerations for 501 by @rartych in https://github.com/camaraproject/Commonalities/pull/374 * Updated linting rules by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/337 and https://github.com/camaraproject/Commonalities/pull/367 * Updated rules when using POST for sensitive data by @eric-murray in https://github.com/camaraproject/Commonalities/pull/358 * Changed guidelines on `x-camara-commonalities` extension field by @rartych in https://github.com/camaraproject/Commonalities/pull/375 From 58b375a1dbbde27c61f6e6a89fe76d190ff57987 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:21:53 +0100 Subject: [PATCH 15/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e3f958a..e251d000 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- * 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](CHANGELOG.md) +For changes see [CHANGELOG.md](CHANGELOG.md). ## Meetings * Meetings are held virtually on the LF Platform: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91016460698?password=d031b0e3-8d49-49ae-958f-af3213b1e547) From 8ada44bc0cd4671eb26dce4358e9b42d68b9ab04 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Fri, 24 Jan 2025 11:04:51 +0100 Subject: [PATCH 16/19] Update CHANGELOG.md 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 | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index daee751e..2ea09f44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,6 @@ This release contains documents and artifacts of Commonalities version 0.5.0-rc. * Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292 * ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/364 * String pattern added to x-correlator scheme by @rartych in https://github.com/camaraproject/Commonalities/pull/373 and updated in https://github.com/camaraproject/Commonalities/pull/387 -* ### Changed * Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316 From 9c45ff800c87c37b831d0326f33fcde53f718929 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:33:42 +0100 Subject: [PATCH 17/19] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index e251d000..816717ce 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ Repository to describe and document common guidelines and assets for CAMARA APIs * All deliverables are mandatory for all CAMARA Sub Projects * Describe, develop, document and test the deliverables * Started: October 2021 -* Location: virtually ## Documents for CAMARA Sub Projects @@ -43,7 +42,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- ## Status and released versions * Release Candidate of version 0.5.0 of guidelines and assets for CAMARA APIs is available with the [r2.2 tag](https://github.com/camaraproject/Commonalities/tree/r2.2) -* 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) +* Release 0.4.0 of guidelines and assets for Fall24 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](CHANGELOG.md). From 35f97fbc860360b5c4bc1057304270e6074e836b Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:42:38 +0100 Subject: [PATCH 18/19] Update event-subscription-template.yaml --- artifacts/camara-cloudevents/event-subscription-template.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/artifacts/camara-cloudevents/event-subscription-template.yaml b/artifacts/camara-cloudevents/event-subscription-template.yaml index 5f4e3b83..7816c4a8 100644 --- a/artifacts/camara-cloudevents/event-subscription-template.yaml +++ b/artifacts/camara-cloudevents/event-subscription-template.yaml @@ -19,7 +19,7 @@ externalDocs: url: https://github.com/camaraproject/ servers: - url: "{apiRoot}/api-name/vx.y" - # api-name and version should valued accordingly to the API + # api-name and version should be valued accordingly to the CAMARA API versioning guidelines, e.g. for a version x.y.z, put v0.y for x=0 or just vx for x>0 in the url. variables: apiRoot: default: http://localhost:9091 From 60d3b95015a064c6495b77c357cd0f7b7185a195 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:12:53 +0100 Subject: [PATCH 19/19] 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 14745e5e..4623460d 100644 --- a/artifacts/CAMARA_common.yaml +++ b/artifacts/CAMARA_common.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: - title: Camara common data types - description: Common data types for Camara APIs + title: CAMARA common data types + description: Common data types for CAMARA APIs license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html