r4.1

Release Notes

This release candidate contains the definition and documentation of

• sim-swap-subscriptions 0.4.0-rc.1
• sim-swap 2.2.0-rc.3

The API definition(s) are based on

• Commonalities r4.3 (0.8.0)
• Identity and Consent Management r4.2 (0.5.0)

sim-swap-subscriptions 0.4.0-rc.1

sim-swap-subscriptions 0.4.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.3.0.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Breaking changes

• GET /subscriptions returns a SubscriptionList object with the required properties subscriptions and pagination, instead of an array of subscriptions

Added

• Pagination for GET /subscriptions: optional page and perPage query parameters, and link, x-total-count and x-total-pages response headers, by @bigludo7 in #272
• PRIVATE_KEY_JWT as sinkCredential.credentialType, by @bigludo7 in #272
• Error codes from the Commonalities r4.3 common error responses: 400 OUT_OF_RANGE (GET /subscriptions), 403 INVALID_TOKEN_CONTEXT, 403 SUBSCRIPTION_MISMATCH, 404 IDENTIFIER_NOT_FOUND, 409 CONFLICT, 409 INCOMPATIBLE_STATE, 422 MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED, 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED, 422 PRIVATE_KEY_JWT_NOT_CONFIGURED and 422 UNSUPPORTED_IDENTIFIER, by @bigludo7 in #272
  • Note: these codes come from the generic Commonalities r4.3 error responses. The list will be trimmed to the codes applicable to this API in the next release candidate, with the adoption of the Commonalities r4.4 error response catalogue.

Changed

• Aligned with the Commonalities r4.3 (0.8.0) event subscription template; most schemas are now taken from the Commonalities common files, by @bigludo7 in #272
• Breaking: GET /subscriptions returns a paginated SubscriptionList object instead of an array, by @bigludo7 in #272
• Adopted the request body strictness rule: requests with JSON bodies containing properties not declared in the specification are rejected with 400 INVALID_ARGUMENT, by @bigludo7 in #272
• config.subscriptionMaxEvents is int32 with a maximum of 1000000, by @rartych in #280
• Updated the API documentation for pagination, sink credentials and the event structure, by @albertoramosmonagas in #290

Fixed

• N/A

Removed

• protocol values AMQP, KAFKA, MQTT3, MQTT5 and NATS, and sinkCredential.credentialType values PLAIN and REFRESHTOKEN, which were already not allowed by the 0.3.0 descriptions, by @bigludo7 in #272

sim-swap 2.2.0-rc.3

sim-swap 2.2.0-rc.3 is a release-candidate version of this API.

Changes documented below are compared to version 2.1.0.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Breaking changes

• N/A

Added

• N/A

Changed

• Adopted the request body strictness rule: requests with JSON bodies containing properties not declared in the specification are rejected with 400 INVALID_ARGUMENT. Per the CAMARA API Design Guide this is not a breaking change; it is the reason for the minor version increase. By @bigludo7 in #272
• Aligned with Commonalities r4.3 (0.8.0): updated mandatory info.description sections, added maxLength to phoneNumber and x-correlator (values were already bounded by the existing patterns), added bounds to the ErrorInfo properties, and constrained monitoredPeriod to int32 in the range 1-999, by @bigludo7 in #272
• Clarified that latestSimChange is null when the provider cannot return it for privacy reasons, by @albertoramosmonagas in #290

Fixed

• N/A

Removed

• N/A

Full Changelog: r3.3...r4.1