Skip to content

r2.3

Latest
Compare
Choose a tag to compare
@rartych rartych released this 21 Feb 07:19
· 7 commits to main since this release
cbf7c4f

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