r3.4

This release contains Commonalities version 0.6.1, a patch release from r3.3.

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.

The relevant details of authentication and consent collection are covered by release 3.3 of Identity and Consent Management Working Group documents.

Fixed

• ErrorInfo schema properties order in template files aligned to CAMARA API Design Guide by @PedroDiez in #517
• Fixed typo in Gherkin Device Errors Template by @PedroDiez in #523
• Fixed link and description of SubscriptionId in event-subscription-template.yaml by @rartych in #536
• Changed networkAccessIdentifier and notification server example to use example.com by @Kevsy in #530

Removed

• Removed "Hashing Passwords" subsection from CAMARA API Design Guide by @AxelNennker in #511

Full Changelog: r3.3...r3.4

r3.3

This release contains documents and artifacts of Commonalities version 0.6.0:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.

The relevant details of authentication and consent collection are covered by release 3.3 of Identity and Consent Management Working Group documents.

Added

• CAMARA API Design Guide document by @rartych in #441
• CAMARA API Event Subscription and Notification Guide document by @bigludo7 in #442
• Links to CAMARA API Event Subscription and Notification Guide in artifacts by @rartych in #453
• Updated Glossary with Terminology from Device Identifier API by @eric-murray in #454
• Text description for duration format fields by @PedroDiez in #459
• Event versioning section added to Guide document by @tanjadegroot in #475
• Not Documented Error Responses info.description section by @PedroDiez in #457
• Enhancements Subscription/Notification Architecture (sink string pattern, special events update) by @PedroDiez in #464
• XCorrelator schema in CAMARA_common.yaml and format checking step in testing template by @PedroDiez in #480
• Added event-notification feature file template by @bigludo7 in #470
• Added Pairwise Pseudonymous Identifier to glossary by @eric-murray in #485
• Recommendation and examples to provide schema context in test definitions by @PedroDiez in #492
• Continuous release numbering guidelines in CAMARA API Design Guide by @tanjadegroot in #505

Changed

• Aligned Error 401 wording in Notification Cloud Events artifact by @PedroDiez in #449
• Updated types property of Subscription allowing more than one event type per subscription by @eric-murray in #432 and clarification on using multiple event types by @rartych in #477
• Request response definitions and other clarifications in chapter 5 of API Design Guide by @rartych in #450
• X-Correlator format changed by @PedroDiez in #463
• Updated Security chapter in CAMARA-API-Design-Guide.md by @rartych in #467
• Sorting Logic in CAMARA-API-Design-Guide.md by @PedroDiez in #471
• Linting rules definition for OpenAPI specfications updated by @rartych in #466
• Updated linting rules for test definitions in .gherkin-lintrc by @rartych in #472
• Editorial improvements of Guide documents and keyword capitalization by @rartych in #494 and #501
• Linting rules updated by @rartych in #502
• Changed Mandatory Description for date-time string format and updated template files by @PedroDiez in #497

Fixed

• Missing bullet point for Mandatory Errors restored in CAMARA API Design Guide by @rartych in #488
• Editorial improvements of Guide documents by @rartych in #494
• Clarified that the DeviceResponse schema is not mandatory by @eric-murray in #490
• ErrorInfo scheme unification in CAMARA_common.yaml and event-subscription-template.yaml by @rartych in #506

Removed

• Removed AUTHENTICATION_REQUIRED error code by @eric-murray in #429
• API Design Guidelines document was deprecated by @rartych in #441
• Removed IDENTIFIER_MISMATCH error and introduced DeviceResponse object by @eric-murray in #455
• Removed IDENTIFIER_MISMATCH from testing artifacts by @jlurien in #479

Full Changelog: r2.3...r3.3

r3.2

This release contains documents and artifacts of Commonalities version 0.6.0-rc.1:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.
  The relevant details of authentication and consent collection are covered by release 3.2 of Identity and Consent Working Group documents.

Added

• CAMARA API Design Guide document by @rartych in #441
• CAMARA API Event Subscription and Notification Guide document by @bigludo7 in #442
• Links to CAMARA API Event Subscription and Notification Guide in artifacts by @rartych in #453
• Updated Glossary with Terminology from Device Identifier API by @eric-murray in #454
• Text description for duration format fields by @PedroDiez in #459
• Event versioning section added to Guide document by @tanjadegroot in #475
• Not Documented Error Responses info.description section by @PedroDiez in #457
• Enhancements Subscription/Notification Architecture (sink string pattern, special events update) by @PedroDiez in #464
• XCorrelator schema in CAMARA_common.yaml and format checking step in testing template by @PedroDiez in #480
• Added event-notification feature file template by @bigludo7 in #470

Changed

• Aligned Error 401 wording in Notification Cloud Events artifact by @PedroDiez in #449
• Updated types property of Subscription allowing more than one event type per subscription by @eric-murray in #432 and clarification on using multiple event types by @rartych in #477
• Request response definitions and other clarifications in chapter 5 of API Design Guide by @rartych in #450
• X-Correlator format changed by @PedroDiez in #463
• Updated Security chapter in CAMARA-API-Design-Guide.md by @rartych in #467
• Sorting Logic in CAMARA-API-Design-Guide.md by @PedroDiez in #471
• Linting rules definition for OpenAPI specfications updated by @rartych in #466
• Updated linting rules for test definitions in .gherkin-lintrc by @rartych in #472

Fixed

N/A

Removed

• Removed AUTHENTICATION_REQUIRED error code by @eric-murray in #429
• API Design Guidelines document was deprecated by @rartych in #441
• Removed IDENTIFIER_MISMATCH error and introduced DeviceResponse object by @eric-murray in #455
• Removed IDENTIFIER_MISMATCH from testing artifacts by @jlurien in #479

Full Changelog: r2.3...r3.2

r3.1

This release contains documents and artifacts of Commonalities version 0.6.0-alpha.1:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.
  The relevant details of authentication and consent collection are covered by release 3.1 of Identity and Consent Working Group documents.

Added

• CAMARA API Design Guide document by @rartych in #441
• CAMARA API Event Subscription and Notification Guide document by @bigludo7 in #442
• Links to CAMARA API Event Subscription and Notification Guide in artifacts by @rartych in #453

Changed

• Aligned Error 401 wording in Notification Cloud Events artifact by @PedroDiez in #449
• Updated types property of Subscription allowing more than one event type per subscription by @eric-murray in #432

Fixed

N/A

Removed

• Removed AUTHENTICATION_REQUIRED error code by @eric-murray in #429
• API Design Guidelines document was deprecated by @rartych in #441

Full Changelog: r2.3...r3.1

r2.3

This release contains documents and artifacts of Commonalities version 0.5.0:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.

The relevant details of authentication and consent collection are covered by release 2.3 of Identity and Consent Management Working Group documents.

Added

• Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in #315
• Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in #331
• Security scheme added to CAMARA_common.yaml by @rartych in #335
• VERSION.yaml file added to indicate Commonalities version by @rartych in #339
• Filtering for boolean guideline and examples in API Design Guidelines by @rartych in #336
• Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in #343
• Common artifacts for testing error scenarios for device and phoneNumber by @jlurien in #325 #381 and #386
• String format/pattern recommendation by @rartych in #330
• Enum values for terminationReason attribute in the guideline document by @bigludo7 in #356
• Created API-cheatsheet.md by @Kevsy in #320
• Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in #292
• ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in #364
• String pattern added to x-correlator scheme by @rartych in #373 and updated in #387
• Extended Notification Security Considerations by @AxelNennker in #277

Changed

• Normalization of error status and code allowed values using enum by @PedroDiez in #316
• Guidelines for subscription and event notification in API Design Guidelines by @bigludo7 in #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 #324 and #346
• Guidelines regarding mandatory error status and alignment of error codes related to identifiers in API Design Guidelines by @PedroDiez in #329 and #351
• Guidelines on non-mandatory error statuses, 429 made non-mandatory and special considerations for 501 by @rartych in #374
• Updated linting rules by @ravindrapalaskar17 in #337 and #367
• Updated rules when using POST for sensitive data by @eric-murray in #358
• Changed guidelines on x-camara-commonalities extension field by @rartych in #375
• Added note and changed descriptions for date-time formats in subscriptions by @dfischer-tech in #404
• Sink format corrected and improved description of protocol and sink properties in API Design Guidelines by @rartych in #414 and @tlohmar in #418

Fixed

• Clarification on api-name, filenames and servers object by @rartych in #333
• Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in #347
• Corrected CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines by @eric-murray in #359
• Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in #361
• Note on support for networkAccessIdentifier in CAMARA_common.yaml by @jlurien in #379
• Improved 403 INVALID_TOKEN_CONTEXT scope/description by @bigludo7 in #377
• Updated message field and description for Error 429 by @rartych in #390
• Updated linting rules documentation by @ravindrapalaskar17 in #413
• Updated Userstory-template.md by @rartych in #412
• Error 429 aligned for event-subscription-template.yaml and notification-as-cloud-event.yaml by @PedroDiez in #407 and #408
• Updated event example in notification-as-cloud-event.yaml by @rartych in #415

Removed

• Removed sinkCredential from Subscription schema in event-subscription-template.yaml by @eric-murray in #400

Full Changelog: r0.4.0...r2.3

r2.2

Release Notes

This release contains documents and artifacts of Commonalities version 0.5.0-rc.1:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.

The relevant details of authentication and consent collection are covered by release 2.2 of Identity and Consent Working Group documents.

Added

• Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in #315
• Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in #331
• Security scheme added to CAMARA_common.yaml by @rartych in #335
• VERSION.yaml file added to indicate Commonalities version by @rartych in #339
• Filtering for boolean guideline and examples in API Design Guidelines by @rartych in #336
• Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in #343
• Common artifacts for testing error scenarios for device and phoneNumber by @jlurien in #325 #381 and #386
• String format/pattern recommendation by @rartych in #330
• Enum values for terminationReason attribute in the guideline document by @bigludo7 in #356
• Created API-cheatsheet.md by @Kevsy in #320
• Added Gherkin linting to Megalinter Workflow by @ravindrapalaskar17 in #292
• ACCESS_TOKEN_EXPIRED termination reason guidance by @bigludo7 in #364
• String pattern added to x-correlator scheme by @rartych in #373 and updated in #387

Changed

• Normalization of error status and code allowed values using enum by @PedroDiez in #316
• Guidelines for subscription and event notification in API Design Guidelines by @bigludo7 in #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 #324 and #346
• Guidelines regarding mandatory error status and alignment of error codes related to identifiers in API Design Guidelines by @PedroDiez in #329 and #351
• Guidelines on non-mandatory error statuses, 429 made non-mandatory and special considerations for 501 by @rartych in #374
• Updated linting rules by @ravindrapalaskar17 in #337 and #367
• Updated rules when using POST for sensitive data by @eric-murray in #358
• Changed guidelines on x-camara-commonalities extension field by @rartych in #375

Fixed

• Clarification on api-name, filenames and servers object by @rartych in #333
• Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in #347
• Corrected CAMARA_common.yaml Generic503 error code to UNAVAILABLE, to match API design guidelines by @eric-murray in #359
• Subscriptions and Notifications artifacts errors aligned with enum values by @PedroDiez in #361
• Note on support for networkAccessIdentifier in CAMARA_common.yaml by @jlurien in #379
• Improved 403 INVALID_TOKEN_CONTEXT scope/description by @bigludo7 in #377
• Updated message field and description for Error 429 by @rartych in #390

Removed

N/A

Full Changelog: r0.4.0...r2.2

r2.1

This release contains documents and artifacts of Commonalities version 0.5.0-alpha.1:

• Commonalities approved deliverables in documentation folder.
• Commonalities approved artifacts in artifacts folder.

The relevant details of authentication and consent collection are covered by release 2.1 of Identity and Consent Working Group documents.

Added

• Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in #315
• Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in #331
• Security scheme added to CAMARA_common.yaml by @rartych in #335
• VERSION.yaml file added to indicate Commonalities version by @rartych in #339
• Filtering for boolean guideline and examples in API Design Guidelines by @rartych in #336
• Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in #343

Changed

• Normalization of error status and code allowed values using enum by @PedroDiez in #316
• Guidelines for subscription and event notification in API Design Guidelines by @bigludo7 in #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 #324 and #346
• Guidelines regarding mandatory error status and alignment of error codes related to identifiers in API Design Guidelines by @PedroDiez in #329 and #351

Fixed

• Clarification on api-name, filenames and servers object by @rartych in #333
• Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in #347

Removed

N/A

Full Changelog: r0.4.0...r2.1

r0.4.0

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
• Commonalities approved artifacts in artifacts folder
  • New:
    • Notification Subscription Template

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 subscription types in event-subscription-template.yaml by @maxl2287 in #236
• SUBSCRIPTION_DELETED as new terminationReason 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

v0.4.0-rc.2

This is the second Release Candidate version for Commonalities release 0.4.0.

It contains the following corrections compared to v0.4.0-rc.1.

Added

• Error 422 UNIDENTIFIABLE_DEVICE added in API Design Guidelines and CAMARA_common.yaml by @rartych in #256

Changed

• 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

Fixed

• 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

Removed

• N/A

Full Changelog: r0.4.0-rc.1...r0.4.0-rc.2

v0.4.0-rc.1

This version introduces Event Subscription model based on CloudEvents Subscriptions API draft and other changes to documents and artifacts approved since v0.3.0.

The relevant details of authentication and consent collection are covered by version 0.2.0 of Identity and Consent Working Group documents.

Please note:

This is the first Release Candidate version for Commonalities release 0.4.0.

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
• Commonalities approved artifacts in artifacts folder
  • New:
    • Notification Subscription Template

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 subscription types in event-subscription-template.yaml by @maxl2287 in #236
• SUBSCRIPTION_DELETED as new terminationReason for CloudEvents by @maxl2287 in #238

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

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

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-rc.1