Skip to content

Latest commit

 

History

History
521 lines (376 loc) · 28.6 KB

CHANGELOG.md

File metadata and controls

521 lines (376 loc) · 28.6 KB

Changelog CarrierBillingCheckOut API Family

Table of Contents

Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.

The below sections record the changes for each API version in each release as follows:

  • for an alpha release, the delta with respect to the previous release
  • for the first release-candidate, all changes since the last public release
  • for subsequent release-candidate(s), only the delta to the previous release-candidate
  • for a public release, the consolidated changes since the previous public release

r2.2

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: https://github.com/camaraproject/CarrierBillingCheckOut/compare/r1.3...r2.2

r2.1 - rc

Release Notes

This release contains the definition and documentation of

  • Carrier Billing v0.4.0-rc.1
  • Carrier Billing Refund v0.2.0-rc.1

The API definition(s) are based on

  • Commonalities v0.5.0-rc.1
  • Identity and Consent Management v0.3.0-alpha.1

Carrier Billing v0.4.0-rc.1

Carrier Billing v0.4.0-rc.1 is the first release-candidate 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.

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.

Fixed

  • Updated accessTokenExpiresUtc description in #202.
  • Some clarifications on descriptions in #202.

Removed

  • Removed 403 - INVALID_TOKEN_CONTEXT in #202.
  • Removed 5XX errors in #202.

Carrier Billing Refund v0.2.0-rc.1

Carrier Billing Refund v0.2.0-rc.1 is the first release-candidate 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.

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.

Fixed

  • Updated accessTokenExpiresUtc description in #202.
  • Some clarifications on descriptions in #202.

Removed

  • Removed 403 - INVALID_TOKEN_CONTEXT in #202.
  • Removed 5XX errors in #202.

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/compare/r2.1...r1.3

r1.3

Release Notes

This release contains the definition and documentation of

  • Carrier Billing v0.3.1
  • Carrier Billing Refund v0.1.1

The API definition(s) are based on

  • Commonalities v0.4.0
  • Identity and Consent Management v0.2.0

Carrier Billing v0.3.1

Carrier Billing v0.3.1 is a public release (patch release for v0.3.0) of the Carrier Billing (Payment) API.

  • This version contains documentational updates compared to v0.3.0, being backwards compatible:

    • Added a section # Generic Clarification about optional parameters within API Spec info.description field

  • API definition with inline documentation:

Main changes since r1.2

Added

  • New section # Generic Clarification about optional parameters within API Spec info.description field in #183

Changed

  • Update README.md with new wiki domain for the Sub-project in #182

Fixed

  • N/A

Removed

  • N/A

Carrier Billing Refund v0.1.1

Carrier Billing Refund v0.1.1 is a public release (patch release for v0.1.0) of the Carrier Billing Refund API.

  • This version contains documentational updates compared to v0.1.0, being backwards compatible:

    • Added a section # Generic Clarification about optional parameters within API Spec info.description field

  • API definition with inline documentation:

Main changes since r1.2

Added

  • New section # Generic Clarification about optional parameters within API Spec info.description field in #183

Changed

  • Update README.md with new wiki domain for the Sub-project in #182

Fixed

  • N/A

Removed

  • N/A

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/compare/r1.2...r1.3

r1.2

Release Notes

This release contains the definition and documentation of

  • Carrier Billing v0.3.0
  • Carrier Billing Refund v0.1.0

The API definition(s) are based on

  • Commonalities v0.4.0
  • Identity and Consent Management v0.2.0

Carrier Billing v0.3.0

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

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

    • Within notifications, callback concept named as webhook has been replaced by the terms sink and sinkCredential in accordance with the updated CAMARA Design Guidelines (Adoption of CloudEvent Subscription Model within MetaRelease Fall24 (v0.4.0))
    • Exceptions has also been aligned with Commonalities MetaRelease-Fall24 (v0.4.0), so as some excepctions has changed their HTTP and/or status values.
    • Version designed to work jointly with Carrier Billing Refund API

  • API definition with inline documentation:

Main changes since r1.1 - rc

Added

  • Basic Test cases definition in #174

Changed

  • Update User Stories in #172
  • Update README.md with meeting info and template alignment in #177
  • Update filename to kebab-case format in #178

Fixed

  • Align 401 Exception Codes with CAMARA Commonalities in #178
  • Align Exceptions naming model with CAMARA Commonalities in #178
  • Fix sink property description in #178
  • Adjust version and servers.url values aligned with Release Mabagement Commonalities in #178
  • Fix externalDocs.url value in #178
  • Fix missing required Request Body for confirmPayment operation in #178

Removed

  • N/A

Carrier Billing Refund v0.1.0

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

  • This version defines a new API:

    • Initial version covering the following functionality and related endpoints:
      • New endpoint createRefund, both total and partial refunds
      • New endpoint retrieveRefunds
      • New endpoint retrieveRefund
      • New endpoint retrievePaymentRemainingAmount
      • Support for Instance-based (implicit) subscription notification mode

  • API definition with inline documentation:

Main changes since r1.1 - rc

Added

  • Generate User Stories in #172
  • Basic Test cases definition in #176

Changed

  • Update README.md with meeting info and template alignment in #177
  • Update filename to kebab-case format in #178

Fixed

  • Align 401 Exception Codes with CAMARA Commonalities in #178
  • Align Exceptions naming model with CAMARA Commonalities in #178
  • Fix sink property description in #178
  • Adjust version and servers.url values aligned with Release Mabagement Commonalities in #178
  • Fix externalDocs.url value in #178

Removed

  • N/A

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/compare/v0.2.1...r1.2

r1.1 - rc

Release Notes

This release contains the definition and documentation of

  • Carrier Billing v0.3.0-rc.1
  • Carrier Billing Refund v0.1.0-rc.1

The API definition(s) are based on

  • Commonalities v0.4.0
  • Identity and Consent Management v0.2.0

Carrier Billing v0.3.0-rc.1

Carrier Billing v0.3.0-rc.1 is the first release-candidate version for v0.3.0 of the Carrier Billing (Payment) API.

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

    • Within notifications, callback concept named as webhook has been replaced by the terms sink and sinkCredential in accordance with the updated CAMARA Design Guidelines (Adoption of CloudEvent Subscription Model within MetaRelease Fall24 (v0.4.0))
    • Exceptions has also been aligned with Commonalities MetaRelease-Fall24 (v0.4.0), so as some excepctions has changed their HTTP and/or status values.
    • Version designed to work jointly with Carrier Billing Refund API

  • API definition with inline documentation:

Added

  • N/A

Changed

  • Support for non-negative amount and taxAmount values in #152
  • Adoption of CloudEvents Subscription Model replacing webhook by sink and sinkCredential concepts as well as aligning callback endpoint for notifications in #152
  • Aligment of Exceptions with Commonalities MetaRelease Fall24 in #152
  • Alignment of Authorization and authentication section with I&CM MetaRelease Fall24 in #152

Fixed

  • Clarifications on descriptions and editorial enhancements in #152

Removed

  • N/A

Carrier Billing Refund v0.1.0-rc.1

Carrier Billing Refund v0.1.0-rc.1 is the first release-candidate version for v0.1.0 of the Carrier Billing Refund API.

  • This version defines a new API:

    • Initial version covering the following functionality and related endpoints:
      • New endpoint createRefund, both total and partial refunds
      • New endpoint retrieveRefunds
      • New endpoint retrieveRefund
      • New endpoint retrievePaymentRemainingAmount
      • Support for Instance-based (implicit) subscription notification mode

  • API definition with inline documentation:

Added

  • Added new Carrier Billing Refund API with the functionality aforementioned indicated (create a refund, query details of a given refund or a list of refunds, retrieve the amount not yet refunded of a given payment, support for implicit-based subscription) in #152
  • Aligned with Commonalities and I&CM MetaRelease Fall24 in #152

Changed

  • N/A

Fixed

  • N/A

Removed

  • N/A

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/compare/v0.2.1...r1.1

v0.2.1

Fix over the first release

Added

  • N/A

Changed

  • N/A

Fixed

  • Fix operationId name of callbacks to be unique.

Removed

  • N/A

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/commits/v0.2.1

v0.2.0

Initial baseline contribution

Please note

  • this "release" is tagged to be the first release of this API.
  • there are ongoing discussions about new features/enhancements so API evolution is expected.

Added

  • Initial version covering the following functionality and related endpoints:
    • One-Step Payment:
      • New endpoint createPayment
    • Two-Step Payment:
      • New endpoint preparePayment
      • New endpoint confirmPayment
      • New endpoint cancelPayment
      • New endpoint (optional, depending on business case need): validatePayment
    • Obtain Payment(s) information:
      • New endpoint retrievePayments
      • New endpoint retrievePayment
    • Support for Instance-based (implicit) subscription notification mode both in One-Step and Two-Step Payment procedures

Changed

  • N/A

Fixed

  • N/A

Removed

  • N/A

New Contributors

  • N/A

Full Changelog: https://github.com/camaraproject/CarrierBillingCheckOut/commits/v0.2.0