Skip to content

r4.4

Latest

Choose a tag to compare

@rartych rartych released this 04 Sep 12:52
a9502a0

This release contains documents and artifacts of Commonalities version 0.9.0:

  • Commonalities approved deliverables in documentation folder.
  • Commonalities approved artifacts in artifacts folder.
  • Analysis of the changes in Commonalities 0.9.0, including impact per API, is available on the project wiki.
    The relevant details of authentication and consent collection are covered by release 4.2 of Identity and Consent Working Group documents.

Added

  • Appendix B - operationId and description guidelines for MCP and AI Agent readiness in CAMARA API Design Guide by @rartych in #664
  • SingleIpv6Address schema added to CAMARA_common.yaml for general use by @eric-murray in #654
  • Date schema added to CAMARA_common.yaml by @eric-murray in #645 and #669
  • Common Sink schema added to CAMARA_common.yaml to be used by API templates by @eric-murray in #646
  • New error EVENT_NOTIFICATIONS_NOT_SUPPORTED (422) added to CAMARA_event_common.yaml for implicit subscriptions by @PedroDiez in #680

Changed

  • sink behaviour clarified in implicit subscription model: providers must deliver events or reject with the new 422 EVENT_NOTIFICATIONS_NOT_SUPPORTED error by @PedroDiez in #680
  • Configuration schema refactored in CAMARA_event_common.yaml (Config, ConfigBase, CreateSubscriptionDetail schemas, initialEvent moved to Config) by @rartych in #670
  • Minimal referenceable error responses and reusable error examples redesign by @hdamker in #665
    • Named, referenceable error-response catalogue added to CAMARA_common.yaml (e.g. BadRequest400, Unauthenticated401, PermissionDenied403, NotFound404, AlreadyExists409, TooManyRequests429)
    • Reusable error examples added to CAMARA_common.yaml
    • Generic* error responses deprecated in favor of the catalogue above (see Deprecated)
    • INVALID_TOKEN_CONTEXT and the deprecated CONFLICT code removed from Generic403/Generic409 (see Removed)
  • sinkCredential model alignment in CAMARA API Event Subscription and Notification Guide by @PedroDiez in #656
  • Integer schema values bounded to the 53-bit safe integer range by @hdamker in #667
  • Schema constraint compatibility guidance clarified by @hdamker in #658
  • accessTokenType description aligned in CAMARA_common.yaml by @PedroDiez in #640
  • Authentication and authorization section in CAMARA API Design Guide rewritten by @AxelNennker in #512

Fixed

  • Spacing added after info.description markers by @hdamker in #660
  • Notification template aligned with CAMARA lint rules by @LarryHu0217 in #679
  • Artifact line endings and Gherkin formatting normalized by @LarryHu0217 in #678
  • Feature file template placeholders normalized to {…} convention and duplicate scenario names made distinct by @hdamker in #683
  • perPage description corrected in CAMARA_common.yaml (was "subscriptions", now "resources") by @rartych in #686
  • Editorial corrections and alignments in testing artifacts by @PedroDiez in #642
  • x-correlator header description rephrased in CAMARA API Design Guide by @tlohmar in #695
  • MISSING_IDENTIFIER descriptions clarified for access tokens in CAMARA_common.yaml and Design Guide by @LarryHu0217 in #689
  • Design Guide ICM (Identity and Consent Management) links repointed to r4.2 instead of r3.3 by @hdamker in #702
  • Initial API version placeholder corrected in CAMARA API Design Guide by @LarryHu0217 in #704
  • Updated Pagination example in API Design Guide by @tlohmar in #698
  • API Readiness Checklist pointer corrected in the mandatory info.description template and CAMARA API Design Guide by @hdamker in #693

Deprecated

  • Generic400, Generic401, Generic403, Generic404, Generic405, Generic406, Generic409, Generic410, Generic412, Generic415, Generic422, Generic429, Generic5xx error responses in CAMARA_common.yaml, in favor of the named catalogue responses above by @hdamker in #665

Removed

  • INVALID_TOKEN_CONTEXT removed from Generic403 in CAMARA_common.yaml by @hdamker in #665
  • Deprecated code CONFLICT removed from Generic409 in CAMARA_common.yaml by @hdamker in #665

New Contributors

Full Changelog: r4.3...r4.4