Skip to content

r2.2

Latest
Compare
Choose a tag to compare
@PedroDiez PedroDiez released this 11 Mar 11:47
· 2 commits to main since this release
d574470

Release Notes

This release contains the definition and documentation of

  • Carrier Billing v0.4.0
  • Carrier Billing Refund v0.2.0

The API definition(s) are based on

  • Commonalities v0.5.0
  • Identity and Consent Management v0.3.0

Carrier Billing v0.4.0

Carrier Billing v0.4.0 is the first public release version for v0.4.0 of the Carrier Billing (Payment) API.

  • This version contains significant changes compared to v0.3.1, and it is not backward compatible:

    • Error model aligment with commonalities, which implies use of normalization values (i.e. enums) for status and code
    • Removal of 403 - INVALID_TOKEN_CONTEXT
    • Removal of 5XX errors
    • Addition of 403 - CARRIER_BILLING.INVALID_PAYMENT_CONTEXT for GET endpoints
    • Addition of applicable 422 traversal exceptions
    • Addition of 429 - TOO_MANY_REQUESTS
  • API definition with inline documentation:

Added

  • Added # Identifying the phone number from the access token section within info.description from Commonalities guideline in #202.
  • Added 403 - CARRIER_BILLING.INVALID_PAYMENT_CONTEXT for GET endpoints, to deal with the case where 3-legged Access Token is not valid for payment context, that is paymentId is not related to the phone number associated to the token in #202.
  • Added applicable 422 traversal exceptions in #202.
  • Added 429 - TOO_MANY_REQUESTS to API endpoints in #202.
  • Added Gherkin Testing Linter in #191.
  • Generate Tests for 429 Error in #206.

Changed

  • Updated # Authorization and authentication section from ICM guideline in #202.
  • Error model aligment with commonalities. Normalization values (i.e. enums) for status and code. In #202.
  • Updated testing plan in #202.
  • Update API specification version and servers.url in #206.
  • Update Test Definitions API version in #206.
  • Update sink format to uri in #206.

Fixed

  • Updated accessTokenExpiresUtc description in #202.
  • Some clarifications on descriptions in #202.
  • Update @{operationId}_403.01_invalid_token_permissions test wording to be more generic in #206.
  • Fix CARRIER_BILLING.INVALID_DATE_RANGE description in #206.

Removed

  • Removed 403 - INVALID_TOKEN_CONTEXT in #202.
  • Removed 5XX errors in #202.
  • Removed sinkCredential from API responses in #206.

Carrier Billing Refund v0.2.0

Carrier Billing Refund v0.2.0 is the first public release version for v0.2.0 of the Carrier Billing Refund API.

  • This version contains significant changes compared to v0.1.1, and it is not backward compatible:

    • Error model aligment with commonalities, which implies use of normalization values (i.e. enums) for status and code
    • Removal of 403 - INVALID_TOKEN_CONTEXT
    • Removal of 5XX errors
    • Addition of 403 - CARRIER_BILLING_REFUND.INVALID_REFUND_CONTEXT for GET endpoints
    • Addition of applicable 422 traversal exceptions
    • Addition of 429 - TOO_MANY_REQUESTS
  • API definition with inline documentation:

Added

  • Added 403 - CARRIER_BILLING_REFUND.INVALID_REFUND_CONTEXT for GET endpoints, to deal with the case where 3-legged Access Token is not valid for refund context, that is refundId is not related to the phone number associated to the token in #202.
  • Added applicable 422 traversal exceptions in #202.
  • Added 429 - TOO_MANY_REQUESTS to API endpoints in #202.
  • Added Gherkin Testing Linter in #191.
  • Generate Tests for 429 Error in #206.

Changed

  • Updated # Authorization and authentication section from ICM guideline in #202.
  • Error model aligment with commonalities. Normalization values (i.e. enums) for status and code. In #202.
  • Updated testing plan in #202.
  • Update API specification version and servers.url in #206.
  • Update Test Definitions API version in #206.
  • Update sink format to uri in #206.

Fixed

  • Updated accessTokenExpiresUtc description in #202.
  • Some clarifications on descriptions in #202.
  • Update @{operationId}_403.01_invalid_token_permissions test wording to be more generic in #206.
  • Fix CARRIER_BILLING_REFUND.INVALID_DATE_RANGE description in #206.
  • Fix some Error exceptions CARRIER_BILLING... to CARRIER_BILLING_REFUND... in #206.

Removed

  • Removed 403 - INVALID_TOKEN_CONTEXT in #202.
  • Removed 5XX errors in #202.
  • Removed sinkCredential from API responses in #206.
  • Remove Content-Last-Key and X-Total-Count from retrieveRefund and retrievePaymentRemainingAmount operations as they are not applicable in #206.

New Contributors

  • N/A

Full Changelog: r1.3...r2.2