Merge pull request #388 from rartych/release-2.2

Release 2.2

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,58 @@
 - **[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 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 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
+* 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
+* 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
+
+### 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
+* 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
+
+**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.2
 
 # r2.1
 ## Release Notes

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
 
@@ -25,6 +24,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,20 +35,21 @@ 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). 
 
 
 ## 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 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 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 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](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)
-* 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  (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

VERSION.yaml

@@ -1 +1 @@
-version: 0.5.0-alpha.1
+version: 0.5.0-rc.1

artifacts/CAMARA_common.yaml

@@ -1,11 +1,11 @@
 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
-  version: wip
+  version: 0.6.0-rc.1
   x-camara-commonalities: 0.5
 
 paths: {}

artifacts/camara-cloudevents/event-subscription-template.yaml

@@ -11,15 +11,15 @@ 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:
   description: Product documentation at CAMARA
   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

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/