Skip to content

Commit cbf7c4f

Browse files
authored
Merge pull request #419 from rartych/release-2.3
Release 2.3
2 parents 64b75f9 + f3f8f9f commit cbf7c4f

6 files changed

+68
-7
lines changed

CHANGELOG.md

+62
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Changelog Commonalities
22

33
## Table of Contents
4+
- **[r2.3](#r23)**
45
- **[r2.2](#r22)**
56
- **[r2.1](#r21)**
67
- **[v0.4.0](#v040)**
@@ -11,6 +12,67 @@
1112
- **[v0.2.0](#v020)**
1213
- **[v0.1.0 - Initial version](#v010---initial-version)**
1314

15+
# r2.3
16+
## Release Notes
17+
18+
This release contains documents and artifacts of Commonalities version 0.5.0:
19+
* Commonalities approved deliverables in **[documentation](https://github.com/camaraproject/Commonalities/tree/r2.3/documentation)** folder.
20+
* Commonalities approved artifacts in **[artifacts](https://github.com/camaraproject/Commonalities/tree/r2.3/artifacts)** folder.
21+
22+
**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.**
23+
24+
### Added
25+
* Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in https://github.com/camaraproject/Commonalities/pull/315
26+
* Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/331
27+
* Security scheme added to CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/335
28+
* VERSION.yaml file added to indicate Commonalities version by @rartych in https://github.com/camaraproject/Commonalities/pull/339
29+
* Filtering for boolean guideline and examples in API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/336
30+
* Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in https://github.com/camaraproject/Commonalities/pull/343
31+
* 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
32+
* String format/pattern recommendation by @rartych in https://github.com/camaraproject/Commonalities/pull/330
33+
* Enum values for `terminationReason` attribute in the guideline document by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/356
34+
* Created API-cheatsheet.md by @Kevsy in https://github.com/camaraproject/Commonalities/pull/320
35+
* Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/292
36+
* ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/364
37+
* 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
38+
* Extended Notification Security Considerations by @AxelNennker in https://github.com/camaraproject/Commonalities/pull/277
39+
40+
### Changed
41+
* Normalization of error status and code allowed values using `enum` by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/316
42+
* Guidelines for subscription and event notification in API Design Guidelines by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/313 main changes:
43+
- updated `terminationReason` in event notification type "subscription-ends"
44+
- updated description of `sink` and `sinkCredential` attributes for subscription
45+
- added rules for subscriptions with device identifier attribute
46+
- added section 11.7 Resource access restriction relevant to subscriptions
47+
- added clarification on `expiresAt` attribute for subscription
48+
* 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
49+
* 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
50+
* 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
51+
* Updated linting rules by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/337 and https://github.com/camaraproject/Commonalities/pull/367
52+
* Updated rules when using POST for sensitive data by @eric-murray in https://github.com/camaraproject/Commonalities/pull/358
53+
* Changed guidelines on `x-camara-commonalities` extension field by @rartych in https://github.com/camaraproject/Commonalities/pull/375
54+
* Added note and changed descriptions for date-time formats in subscriptions by @dfischer-tech in https://github.com/camaraproject/Commonalities/pull/404
55+
* 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
56+
57+
### Fixed
58+
* Clarification on api-name, filenames and servers object by @rartych in https://github.com/camaraproject/Commonalities/pull/333
59+
* Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in https://github.com/camaraproject/Commonalities/pull/347
60+
* 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
61+
* Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in https://github.com/camaraproject/Commonalities/pull/361
62+
* Note on support for networkAccessIdentifier in CAMARA_common.yaml by @jlurien in https://github.com/camaraproject/Commonalities/pull/379
63+
* Improved 403 INVALID_TOKEN_CONTEXT scope/description by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/377
64+
* Updated message field and description for Error 429 by @rartych in https://github.com/camaraproject/Commonalities/pull/390
65+
* Updated linting rules documentation by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/413
66+
* Updated Userstory-template.md by @rartych in https://github.com/camaraproject/Commonalities/pull/412
67+
* 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
68+
* Updated event example in notification-as-cloud-event.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/415
69+
70+
71+
### Removed
72+
* Removed sinkCredential from Subscription schema in event-subscription-template.yaml by @eric-murray in https://github.com/camaraproject/Commonalities/pull/400
73+
74+
**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.3
75+
1476
# r2.2
1577
## Release Notes
1678

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-
4141

4242

4343
## Status and released versions
44-
* 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)
45-
* 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)
44+
* 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)
4645
* Previous releases and pre-releases are available in https://github.com/camaraproject/Commonalities/releases
4746

4847
For changes see [CHANGELOG.md](CHANGELOG.md).

VERSION.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version: wip
1+
version: 0.5.0

artifacts/CAMARA_common.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ info:
55
license:
66
name: Apache 2.0
77
url: https://www.apache.org/licenses/LICENSE-2.0.html
8-
version: wip
8+
version: 0.6.0
99
x-camara-commonalities: 0.5
1010

1111
paths: {}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ info:
1111
license:
1212
name: Apache 2.0
1313
url: https://www.apache.org/licenses/LICENSE-2.0.html
14-
version: wip
14+
version: 0.2.0
1515
x-camara-commonalities: 0.5
1616

1717
externalDocs:

artifacts/notification-as-cloud-event.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ info:
4242
license:
4343
name: Apache 2.0
4444
url: https://www.apache.org/licenses/LICENSE-2.0.html
45-
version: wip
45+
version: 0.2.0
4646
externalDocs:
4747
description: Product documentation at CAMARA
48-
url: https://github.com/camaraproject/
48+
url: https://github.com/camaraproject/Commonalities
4949
security:
5050
- notificationsBearerAuth: []
5151
- {}

0 commit comments

Comments
 (0)