Skip to content

Latest commit

 

History

History
461 lines (369 loc) · 40.4 KB

CHANGELOG.md

File metadata and controls

461 lines (369 loc) · 40.4 KB

Changelog Commonalities

Table of Contents

r2.3

Release Notes

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

Changed

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

Fixed

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

Removed

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

Full Changelog: https://github.com/camaraproject/Commonalities/compare/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

Changed

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

Fixed

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

Removed

N/A

Full Changelog: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.2

r2.1

Release Notes

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 camaraproject#315
  • Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in camaraproject#331
  • Security scheme added to CAMARA_common.yaml by @rartych in camaraproject#335
  • VERSION.yaml file added to indicate Commonalities version by @rartych in camaraproject#339
  • Filtering for boolean guideline and examples in API Design Guidelines by @rartych in camaraproject#336
  • Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in camaraproject#343

Changed

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

Fixed

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

Removed

N/A

Full Changelog: https://github.com/camaraproject/Commonalities/compare/r0.4.0...r2.1

v0.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:

Added

  • Usage and style of operation tags in API Design Guidelines by @rartych in camaraproject#152
  • x-correlator support in notifications in API Design Guidelines by @PedroDiez in camaraproject#170
  • Create subscription-notification-template.yaml by @bigludo7 in camaraproject#189
  • Added a different scope naming format for APIs that deal with explicit subscriptions by @shilpa-padgaonkar in camaraproject#177
  • 'info' object, 'servers' added in chapter 11 of API Design Guidelines: by @rartych in camaraproject#214
  • Guidelines on device identification in Annex A of API Design Guidelines and device object usage in CAMARA_common.yaml by @jpengar in camaraproject#233
  • minItems: 1 & maxItems: 1 for subscription types in event-subscription-template.yaml by @maxl2287 in camaraproject#236
  • SUBSCRIPTION_DELETED as new terminationReason for CloudEvents by @maxl2287 in camaraproject#238
  • Error 422 UNIDENTIFIABLE_DEVICE added in API Design Guidelines and CAMARA_common.yaml by @rartych in camaraproject#256

Changed

  • API Design Guidelines updated with subscriptionMaxEvents by @bigludo7 in camaraproject#131
  • 'specversion' in CloudEvents as enum by @PedroDiez in camaraproject#187
  • 'datacontenttype' in CloudEvents as enum by @PedroDiez in camaraproject#193
  • API Design Guidelines updated on x-correlator format by @PedroDiez in camaraproject#194
  • API Design Guidelines for Notification Subscription by @bigludo7 in camaraproject#198
  • API Design Guidelines updated on scope definition including wildcard scopes by @shilpa-padgaonkar in camaraproject#221
  • API Design Guidelines adapted to ICM Security and Interoperability Profile by @AxelNennker in camaraproject#208
  • Error response model updated in chapter 6 of API Design Guidelines by @PedroDiez in camaraproject#213
  • Enhanced API-Testing-Guidelines.md by @jlurien in camaraproject#203
  • Updated API versioning guidelines chapter 5 of API Design Guidelines by @tanjadegroot in camaraproject#215
  • Errors in event-subscription-template.yaml aligned with CAMARA_common.yaml by @bigludo7 in camaraproject#251
  • CAMARA_common.yaml - info object aligned with API Design Guidelines by @rartych in camaraproject#257
  • API-DocumentationTemplate.md marked as deprecated by @rartych in camaraproject#261
  • Updated event-subscription-template.yaml with attribute startsAt set optional, sinkCredential definition, and other corrections by @rartych in camaraproject#267
  • Filename boilerplate changed to kebab-case to match examples in API-Testing-Guidelines.md by @Kevsy in camaraproject#281

Fixed

  • API Design Guidelines updated with character set guidance by @trehman-gsma in camaraproject#143
  • Mandated '+' in all phoneNumber formats by @fernandopradocabrillo in camaraproject#148
  • Linting rules problem with Traffic Influence API #161 by @VijayKesharwani in camaraproject#169
  • CAMARA_common.yaml - bugs and typos fix by @fernandopradocabrillo in camaraproject#174
  • API Design Guidelines updated on HTTPs usage by @AxelNennker in camaraproject#205
  • Artifacts aligned with API Design Guidelines for Notification Subscription by @PedroDiez in camaraproject#219
  • API Design Guidelines - fixed typos and internal references, formatted tables, restructured sentences by @maxl2287 in camaraproject#229
  • Files in documentation folder - formatted tables, fixed grammar and style issues by @maxl2287 in camaraproject#234
  • API Design Guidelines - formatting corrected in section 11.6.1 by @rartych in camaraproject#255
  • MNO abbreviation replaced in CAMARA_common.yaml by @rartych in camaraproject#270
  • Broken links replaced with relative links in API-linting-Implementation-Guideline.md by @eric-murray in camaraproject#274
  • Links between Commonalities documents set to relative (in API Design Guidelines, Issue and PR template Howto, Linting-rules) by @PedroDiez in camaraproject#283

Removed

Full Changelog: https://github.com/camaraproject/Commonalities/compare/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 camaraproject#256

Changed

  • Errors in event-subscription-template.yaml aligned with CAMARA_common.yaml by @bigludo7 in camaraproject#251
  • CAMARA_common.yaml - info object aligned with API Design Guidelines by @rartych in camaraproject#257
  • API-DocumentationTemplate.md marked as deprecated by @rartych in camaraproject#261
  • Updated event-subscription-template.yaml with attribute startsAt set optional, sinkCredential definition, and other corrections by @rartych in camaraproject#267

Fixed

  • API Design Guidelines - formatting corrected in section 11.6.1 by @rartych in camaraproject#255
  • MNO abbreviation replaced in CAMARA_common.yaml by @rartych in camaraproject#270

Removed

  • N/A

Full Changelog: https://github.com/camaraproject/Commonalities/compare/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:

Added

  • Usage and style of operation tags in API Design Guidelines by @rartych in camaraproject#152
  • x-correlator support in notifications in API Design Guidelines by @PedroDiez in camaraproject#170
  • Create subscription-notification-template.yaml by @bigludo7 in camaraproject#189
  • Added a different scope naming format for APIs that deal with explicit subscriptions by @shilpa-padgaonkar in camaraproject#177
  • 'info' object, 'servers' added in chapter 11 of API Design Guidelines: by @rartych in camaraproject#214
  • Guidelines on device identification in Annex A of API Design Guidelines and device object usage in CAMARA_common.yaml by @jpengar in camaraproject#233
  • minItems: 1 & maxItems: 1 for subscription types in event-subscription-template.yaml by @maxl2287 in camaraproject#236
  • SUBSCRIPTION_DELETED as new terminationReason for CloudEvents by @maxl2287 in camaraproject#238

Changed

  • API Design Guidelines updated with subscriptionMaxEvents by @bigludo7 in camaraproject#131
  • 'specversion' in CloudEvents as enum by @PedroDiez in camaraproject#187
  • 'datacontenttype' in CloudEvents as enum by @PedroDiez in camaraproject#193
  • API Design Guidelines updated on x-correlator format by @PedroDiez in camaraproject#194
  • API Design Guidelines for Notification Subscription by @bigludo7 in camaraproject#198
  • API Design Guidelines updated on scope definition including wildcard scopes by @shilpa-padgaonkar in camaraproject#221
  • API Design Guidelines adapted to ICM Security and Interoperability Profile by @AxelNennker in camaraproject#208
  • Error response model updated in chapter 6 of API Design Guidelines by @PedroDiez in camaraproject#213
  • Enhanced API-Testing-Guidelines.md by @jlurien in camaraproject#203
  • Updated API versioning guidelines chapter 5 of API Design Guidelines by @tanjadegroot in camaraproject#215

Fixed

  • API Design Guidelines updated with character set guidance by @trehman-gsma in camaraproject#143
  • Mandated '+' in all phoneNumber formats by @fernandopradocabrillo in camaraproject#148
  • Linting rules problem with Traffic Influence API #161 by @VijayKesharwani in camaraproject#169
  • CAMARA_common.yaml - bugs and typos fix by @fernandopradocabrillo in camaraproject#174
  • API Design Guidelines updated on HTTPs usage by @AxelNennker in camaraproject#205
  • Artifacts aligned with API Design Guidelines for Notification Subscription by @PedroDiez in camaraproject#219
  • API Design Guidelines - fixed typos and internal references, formatted tables, restructured sentences by @maxl2287 in camaraproject#229
  • Files in documentation folder - formatted tables, fixed grammar and style issues by @maxl2287 in camaraproject#234

Removed

Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.3.0...r0.4.0-rc.1

v0.4.0-alpha.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.

Please note:

This is ALPHA version for Commonalities release 0.4.0. The following changes are expected to be added in the Release Candidate:

  • Error model alignment PR#213
  • Enhance API-Testing-Guidelines.md PR#203
  • API Design Guidelines chapter 11: 'info' object, 'servers' object and cleanup PR#214
  • Alignment with ICM and Release Management

The content of the release includes:

Added

  • Usage and style of operation tags in API Design Guidelines by @rartych in camaraproject#152
  • x-correlator support in notifications in API Design Guidelines by @PedroDiez in camaraproject#170
  • Create subscription-notification-template.yaml by @bigludo7 in camaraproject#189
  • Added a different scope naming format for APIs that deal with explicit subscriptions by @shilpa-padgaonkar in camaraproject#177

Changed

  • API Design Guidelines updated with subscriptionMaxEvents by @bigludo7 in camaraproject#131
  • 'specversion' in CloudEvents as enum by @PedroDiez in camaraproject#187
  • 'datacontenttype' in CloudEvents as enum by @PedroDiez in camaraproject#193
  • API Design Guidelines updated on x-correlator format by @PedroDiez in camaraproject#194
  • API Design Guidelines for Notification Subscription by @bigludo7 in camaraproject#198
  • API Design Guidelines updated on scope definition including wildcard scopes by @shilpa-padgaonkar in camaraproject#221

Fixed

  • API Design Guidelines updated with character set guidance by @trehman-gsma in camaraproject#143
  • Mandated '+' in all phoneNumber formats by @fernandopradocabrillo in camaraproject#148
  • Linting rules problem with Traffic Influence API #161 by @VijayKesharwani in camaraproject#169
  • CAMARA_common.yaml - bugs and typos fix by @fernandopradocabrillo in camaraproject#174
  • API Design Guidelines updated on HTTPs usage by @AxelNennker in camaraproject#205
  • Artifacts aligned with API Design Guidelines for Notification Subscription by @PedroDiez in camaraproject#219

Removed

Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.3.0...r0.4.0-alpha.1

v0.3.0

This version introduces API Testing Guidelines and initial linting ruleset and other changes to documents and artifacts approved since v0.2.0.

Please note:

The content of the release includes:

Added

  • API Testing Guidelines created by @shilpa-padgaonkar in camaraproject#117
  • API Design Guidelines updated with scopes naming guidelines by @jlurien in camaraproject#57
  • API Linting Rules - initial linting ruleset description by @rartych in camaraproject#74
  • API linting implementation and guidelines by @ravindrapalaskar17 in camaraproject#110

Changed

  • CAMARA_common.yaml includes the following changes:

    • CAMARA_common.json was changed to CAMARA_common.yaml to be consistent with all CAMARA API specs
    • Includes guidance for info object
    • Adds the aligned device schema updated by @shilpa-padgaonkar in camaraproject#107

  • X-Correlator header as required in OAS definition, X-Version removed from API Design Guidelines by @jlurien in camaraproject#115

  • Filtering criteria in API Design Guidelines changed by @RubenBG7 in camaraproject#132

Fixed

  • CAMARA_common.yaml - error response codes updated by @RubenBG7 in camaraproject#124
  • API Design Guidelines updated on response filtering by @rartych in camaraproject#123

Removed

  • API-exposure-reference-solution.docx removed from documentation/SupportingDocuments by @jordonezlucena in camaraproject#104

Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.2.0...v0.3.0

v0.2.0

This version introduces CloudEvents format to CAMARA Events and other changes to documents and artifacts approved since v0.1.0.

Please note:

The content of the release includes:

Added

Changed

  • Updated API Design Guidelines with use of callbacks & cloudEvents by @bigludo7 in camaraproject#56
  • Updated Architecture headers in API Design Guidelines by @eric-murray in camaraproject#88

Fixed

  • Fixed code typos in API Design Guidelines section 11.5.1 code sample by @Kevsy in camaraproject#48
  • Correction of format and typos by @dfischer-tech in camaraproject#79
  • Improved discovery of Commonalities output documents by API Subprojects by @rkandoi in camaraproject#73
  • Updated references in UE-Identification.md by @gmuratk in camaraproject#95
  • Minor changes needed in API Design Guidelines for CloudEvents by @rartych in camaraproject#86
  • Filtering GET results - updated section 8.3 in API Design Guidelines by @rartych in camaraproject#82

Removed

  • Removed option to use HTTP HEAD from API-design-guidelines.md by @eric-murray in camaraproject#50

Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.1.0...v.0.2.0

v0.1.0 - Initial version

Initial version of guidelines and assets based on the work done in Commonalities WG.

Please note:

The content of the release includes:

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