Merge pull request #342 from rartych/release-2.1

Release 2.1

CHANGELOG.md

@@ -1,14 +1,52 @@
 # 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
+* 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
+
+### 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
+
+### 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
+
+**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.1
 
 
 # v0.4.0

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)

VERSION.yaml

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

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:

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

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/