Skip to content

Latest commit

 

History

History
346 lines (270 loc) · 28.6 KB

CHANGELOG.md

File metadata and controls

346 lines (270 loc) · 28.6 KB
Raw

Changelog Commonalities

Table of Contents

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 #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: 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 #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: 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 #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: 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 #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: 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 #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

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

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

Removed

  • Removed UUID pattern for x-correlator by @jlurien in #168

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 #117
  • API Design Guidelines updated with scopes naming guidelines by @jlurien in #57
  • API Linting Rules - initial linting ruleset description by @rartych in #74
  • API linting implementation and guidelines by @ravindrapalaskar17 in #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 #107

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

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

Fixed

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

Removed

  • API-exposure-reference-solution.docx removed from documentation/SupportingDocuments by @jordonezlucena in #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

  • Added reserved word restrictions to API Design Guidelines by @eric-murray in #49
  • Explicitly indicated use of RFC3339 for DateTime attributes by @patrice-conil in #55
  • Usage of discriminator: Encourage inheritance rather than polymorphism by @patrice-conil in #22
  • Use ObjectName as discriminator's mapping key by @patrice-conil in #78
  • OAS definition of CAMARA Event using Cloudevents in artifacts: notification-as-cloud-event.yaml by @patrice-conil in #43

Changed

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

Fixed

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

Removed

  • Removed option to use HTTP HEAD from API-design-guidelines.md by @eric-murray in #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: