Release r2.1 (Release Candidate)

camaraproject · Jan 14, 2025 · 105a4a9 · 105a4a9
1 parent 4972217
commit 105a4a9
Show file tree

Hide file tree

Showing 17 changed files with 822 additions and 402 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Table of Contents
 
+- [r2.1 - rc](#r21---rc)
 - [r1.3](#r13)
 - [r1.2](#r12)
 - [r1.1 - rc](#r11---rc)
@@ -16,6 +17,96 @@ The below sections record the changes for each API version in each release as fo
 * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
 * for a public API version, the consolidated changes since the release of the previous public API version
 
+## 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-alpha.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**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier_billing.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier_billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.1/code/API_definitions/carrier_billing.yaml)
+
+### Added
+* Added `# Identifying the phone number from the access token` section within `info.description` from Commonalities guideline.
+* 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.
+* Added applicable `422` traversal exceptions  
+* Added `429 - TOO_MANY_REQUESTS` to API endpoints.
+* Added Gherkin Testing Linter in https://github.com/camaraproject/CarrierBillingCheckOut/pull/191.
+
+### Changed
+* Updated `# Authorization and authentication` section from ICM guideline.
+* Error model aligment with commonalities. Normalization values (i.e. enums) for `status` and `code`.
+
+
+### Fixed
+* Updated `accessTokenExpiresUtc` description 
+* Some clarifications on descriptions.
+
+### Removed
+* Removed `403 - INVALID_TOKEN_CONTEXT`
+* Removed `5XX` errors
+
+## 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**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier_billing_refund.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier_billing_refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.1/code/API_definitions/carrier_billing_refund.yaml)
+
+### 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.
+* Added applicable `422` traversal exceptions  
+* Added `429 - TOO_MANY_REQUESTS` to API endpoints.
+* Added Gherkin Testing Linter in https://github.com/camaraproject/CarrierBillingCheckOut/pull/191.
+
+### Changed
+* Updated `# Authorization and authentication` section from ICM guideline.
+* Error model aligment with commonalities. Normalization values (i.e. enums) for `status` and `code`.
+
+
+### Fixed
+* Updated `accessTokenExpiresUtc` description 
+* Some clarifications on descriptions.
+
+### Removed
+* Removed `403 - INVALID_TOKEN_CONTEXT`
+* Removed `5XX` errors
+
+## New Contributors
+* N/A
+
+
+**Full Changelog**: https://github.com/camaraproject/CarrierBillingCheckOut/compare/r2.1...r1.3
+
 ## r1.3
 
 ## Release Notes

diff --git a/README.md b/README.md
@@ -26,19 +26,19 @@ Repository to describe, develop, document and test the CarrierBilling API family
 <!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/§repo_name§/blob/main/CHANGELOG.md) -->
 * Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
 
-* **The Release [r1.3](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md#r1.3) for the Carrier Billing APIs Family is available.**
-<br>This is a public release.
-
-* The release **r1.3** is available in [r1.3](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r1.3), and includes the following APIs:
-- API name: Carrier Billing (Payment) - API Definition v0.3.1 with inline documentation:
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.3/code/API_definitions/carrier-billing.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.3/code/API_definitions/carrier-billing.yaml)
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.3/code/API_definitions/carrier-billing.yaml)
-
-- API name: Carrier Billing Refund - API Definition v0.1.1 with inline documentation:
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.3/code/API_definitions/carrier-billing-refund.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.3/code/API_definitions/carrier-billing-refund.yaml)
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.3/code/API_definitions/carrier-billing-refund.yaml)
+* **The Release [r2.1 - rc](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md#r2.1---rc) for the Carrier Billing APIs Family is available.**
+<br>This is a release candidate. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
+
+* The release **r2.1 - rc** is available in [r2.1](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r2.1), and includes the following APIs:
+- API name: Carrier Billing (Payment) - API Definition v0.4.0-rc.1 with inline documentation:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier-billing.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier-billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.1/code/API_definitions/carrier-billing.yaml)
+
+- API name: Carrier Billing Refund - API Definition v0.2.0-rc.1 with inline documentation:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier-billing-refund.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.1/code/API_definitions/carrier-billing-refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.1/code/API_definitions/carrier-billing-refund.yaml)
 
 * Other releases of this sub project are available in [CarrierBillingCheckout Releases](https://github.com/camaraproject/CarrierBillingCheckout/releases)
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/CarrierBillingCheckout/blob/main/CHANGELOG.md)