Merge pull request #419 from rartych/release-2.3

Release 2.3

Author: rartych

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog Commonalities
 
 ## Table of Contents
+- **[r2.3](#r23)**
 - **[r2.2](#r22)**
 - **[r2.1](#r21)**
 - **[v0.4.0](#v040)**
@@ -11,6 +12,67 @@
 - **[v0.2.0](#v020)**
 - **[v0.1.0 - Initial version](#v010---initial-version)**
 
+# r2.3
+## Release Notes
+
+This release contains documents and artifacts of Commonalities version 0.5.0:
+* Commonalities approved deliverables in **[documentation](https://github.com/camaraproject/Commonalities/tree/r2.3/documentation)** folder.
+* Commonalities approved artifacts in **[artifacts](https://github.com/camaraproject/Commonalities/tree/r2.3/artifacts)** folder.
+
+**The relevant details of authentication and consent collection are covered by [release 2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases) of Identity and Consent Management 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
+* Extended Notification Security Considerations by @AxelNennker in https://github.com/camaraproject/Commonalities/pull/277
+
+### 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
+* Added note and changed descriptions for date-time formats in subscriptions by @dfischer-tech in https://github.com/camaraproject/Commonalities/pull/404
+* Sink format corrected and improved description of protocol and sink properties in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/414 and @tlohmar in https://github.com/camaraproject/Commonalities/pull/418
+
+### 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
+* Updated linting rules documentation by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/413
+* Updated Userstory-template.md by @rartych in https://github.com/camaraproject/Commonalities/pull/412
+* Error 429 aligned for event-subscription-template.yaml and notification-as-cloud-event.yaml by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/407 and https://github.com/camaraproject/Commonalities/pull/408
+* Updated event example in notification-as-cloud-event.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/415
+
+  
+### Removed
+* Removed sinkCredential from Subscription schema in event-subscription-template.yaml by @eric-murray in https://github.com/camaraproject/Commonalities/pull/400
+
+**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.3
+
 # r2.2
 ## Release Notes
 

README.md

@@ -41,8 +41,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 Fall24 CAMARA APIs is available with the [r0.4.0 tag](https://github.com/camaraproject/Commonalities/tree/r0.4.0)
+* Release 0.5.0 of guidelines and assets for Spring 25 CAMARA APIs is available with the [r2.3 tag](https://github.com/camaraproject/Commonalities/tree/r2.3)
 * Previous releases and pre-releases are available in https://github.com/camaraproject/Commonalities/releases
 
 For changes see [CHANGELOG.md](CHANGELOG.md).

VERSION.yaml

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

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
   x-camara-commonalities: 0.5
 
 paths: {}

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: wip
+  version: 0.2.0
   x-camara-commonalities: 0.5
 
 externalDocs:

artifacts/notification-as-cloud-event.yaml

@@ -42,10 +42,10 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.2.0
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/
+  url: https://github.com/camaraproject/Commonalities
 security:
     - notificationsBearerAuth: []
     - {}