This is the public release of Commonalities version 0.4.0.
This version introduces Event Subscription model based on CloudEvents Subscriptions API draft and other changes to documents and artifacts approved since version 0.3.0.
The relevant details of authentication and consent collection are covered by version 0.2.0 of Identity and Consent Working Group documents.
The content of the release includes:
- Commonalities approved deliverables in documentation folder
- Removed or deprecated:
- API-Readiness-Checklist.md
- Camara_Versioning_Guidelines.md
- CHANGELOG_TEMPLATE.md
- Removed or deprecated:
- Commonalities approved artifacts in artifacts folder
Added
- Usage and style of operation tags in API Design Guidelines by @rartych in #152
- x-correlator support in notifications in API Design Guidelines by @PedroDiez in #170
- Create subscription-notification-template.yaml by @bigludo7 in #189
- Added a different scope naming format for APIs that deal with explicit subscriptions by @shilpa-padgaonkar in #177
- 'info' object, 'servers' added in chapter 11 of API Design Guidelines: by @rartych in #214
- Guidelines on device identification in Annex A of API Design Guidelines and device object usage in CAMARA_common.yaml by @jpengar in #233
minItems: 1
&maxItems: 1
for subscriptiontypes
in event-subscription-template.yaml by @maxl2287 in #236SUBSCRIPTION_DELETED
as newterminationReason
for CloudEvents by @maxl2287 in #238- Error 422 UNIDENTIFIABLE_DEVICE added in API Design Guidelines and CAMARA_common.yaml by @rartych in #256
Changed
- API Design Guidelines updated with subscriptionMaxEvents by @bigludo7 in #131
- 'specversion' in CloudEvents as enum by @PedroDiez in #187
- 'datacontenttype' in CloudEvents as enum by @PedroDiez in #193
- API Design Guidelines updated on x-correlator format by @PedroDiez in #194
- API Design Guidelines for Notification Subscription by @bigludo7 in #198
- API Design Guidelines updated on scope definition including wildcard scopes by @shilpa-padgaonkar in #221
- API Design Guidelines adapted to ICM Security and Interoperability Profile by @AxelNennker in #208
- Error response model updated in chapter 6 of API Design Guidelines by @PedroDiez in #213
- Enhanced API-Testing-Guidelines.md by @jlurien in #203
- Updated API versioning guidelines chapter 5 of API Design Guidelines by @tanjadegroot in #215
- Errors in event-subscription-template.yaml aligned with CAMARA_common.yaml by @bigludo7 in #251
- CAMARA_common.yaml - info object aligned with API Design Guidelines by @rartych in #257
- API-DocumentationTemplate.md marked as deprecated by @rartych in #261
- Updated event-subscription-template.yaml with attribute startsAt set optional, sinkCredential definition, and other corrections by @rartych in #267
- Filename boilerplate changed to kebab-case to match examples in API-Testing-Guidelines.md by @Kevsy in #281
Fixed
- API Design Guidelines updated with character set guidance by @trehman-gsma in #143
- Mandated '+' in all phoneNumber formats by @fernandopradocabrillo in #148
- Linting rules problem with Traffic Influence API #161 by @VijayKesharwani in #169
- CAMARA_common.yaml - bugs and typos fix by @fernandopradocabrillo in #174
- API Design Guidelines updated on HTTPs usage by @AxelNennker in #205
- Artifacts aligned with API Design Guidelines for Notification Subscription by @PedroDiez in #219
- API Design Guidelines - fixed typos and internal references, formatted tables, restructured sentences by @maxl2287 in #229
- Files in documentation folder - formatted tables, fixed grammar and style issues by @maxl2287 in #234
- API Design Guidelines - formatting corrected in section 11.6.1 by @rartych in #255
- MNO abbreviation replaced in CAMARA_common.yaml by @rartych in #270
- Broken links replaced with relative links in API-linting-Implementation-Guideline.md by @eric-murray in #274
- Links between Commonalities documents set to relative (in API Design Guidelines, Issue and PR template Howto, Linting-rules) by @PedroDiez in #283
Removed
- Removed UUID pattern for x-correlator by @jlurien in #168
- Deprecated API-Readiness-Checklist.md by @rartych in #220
- Removed Camara_Versioning_Guidelines.md by @tanjadegroot in #215
- Deprecated CHANGELOG_TEMPLATE.md by @rartych in #239
Full Changelog: v0.3.0...r0.4.0