Release Candidate r3.1

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Table of Contents
 
+- [r3.1 - rc](#r31---rc)
 - [r2.2](#r22)
 - [r2.1 - rc](#r21---rc)
 - [r1.3](#r13)
@@ -19,6 +20,95 @@ The below sections record the changes for each API version in each release as fo
 * 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
 
+## r3.1 - rc
+
+## Release Notes
+
+This release contains the definition and documentation of
+* Carrier Billing v0.5.0-rc.1
+* Carrier Billing Refund v0.3.0-rc.1
+
+The API definition(s) are based on
+* Commonalities v0.6.0-rc.1
+* Identity and Consent Management v0.4.0-rc.1
+
+## Carrier Billing v0.5.0-rc.1
+
+**Carrier Billing v0.5.0-rc.1 is the first release-candidate version for v0.5.0 of the Carrier Billing API.**
+- **This version contains significant changes compared to v0.4.0:**
+  - Removal of `401 - AUTHENTICATION_REQUIRED`
+  - New pattern for `x-correlator`
+  - Addition of a new section `# Additional CAMARA error responses` in `info.description` field
+  - Addition of `404 - INVALID_SINK` in `createPayment` and `preparePayment` endpoints
+  - Addition of `404 - IDENTIFIER_NOT_FOUND` in `createPayment`, `preparePayment`, `confirmPayment` and `cancelPayment` endpoints
+  - Addition of `404 - NOT_FOUND` in `validatePayment` endpoint
+  - Removal of `403 - CARRIER_BILLING.INVALID_PAYMENT_CONTEXT` in `retrievePayment` and `retrievePayments` endpoints 
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.1/code/API_definitions/carrier-billing.yaml)
+
+### Added
+* New section `# Additional CAMARA error responses` in `info.description` field in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* `404 - INVALID_SINK` error in `createPayment` and `preparePayment` endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* `404 - IDENTIFIER_NOT_FOUND` error in `createPayment`, `preparePayment`, `confirmPayment` and `cancelPayment` endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/217.
+* `404 - NOT_FOUND` error in `validatePayment` endpoint in https://github.com/camaraproject/CarrierBillingCheckOut/pull/217.
+* New test for invalid `x-correlator` in Gherkin `.feature` files in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+* Error 404 testing scenarios in Gherkin `.feature` files for `createPayment`, `preparePayment`, `confirmPayment`, `cancelPayment` and `validatePayment` in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+### Changed
+* New pattern for `x-correlator` and model aligment with Commonalities in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* Update Gherkin `.feature` files with Commonalities testing guidelines in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+* Update test for invalid sink in Gherkin `.feature` files for `createPayment` and `preparePayment` endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+### Fixed
+* N/A
+
+### Removed
+* `401 - AUTHENTICATION_REQUIRED` error in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* `403 - CARRIER_BILLING.INVALID_PAYMENT_CONTEXT` error in `retrievePayment` and `retrievePayments` endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/226.
+* Test `@*_403.02_phoneNumber_token_mismatch` in Gherkin `.feature` files for `retrievePayment` and `retrievePayments` in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+## Carrier Billing Refund v0.3.0-rc.1
+
+**Carrier Billing Refund v0.3.0-rc.1 is the first release-candidate version for v0.3.0 of the Carrier Billing Refund API.**
+- **This version contains significant changes compared to v0.2.0:**
+  - Removal of `401 - AUTHENTICATION_REQUIRED`
+  - New pattern for `x-correlator`
+  - Addition of a new section `# Additional CAMARA error responses` in `info.description` field
+  - Addition of `404 - INVALID_SINK` in `createRefund` endpoint
+  - Removal of `403 - CARRIER_BILLING.INVALID_REFUND_CONTEXT`
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing-refund.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing-refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.1/code/API_definitions/carrier-billing-refund.yaml)
+
+### Added
+* * New section `# Additional CAMARA error responses` in `info.description` field in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* `404 - INVALID_SINK` error in `createRefund` endpoint in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* New test for invalid `x-correlator` in Gherkin `.feature` files in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+### Changed
+* New pattern for `x-correlator` and model aligment with Commonalities in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* Update Gherkin `.feature` files with Commonalities testing guidelines in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+* Update test for invalid sink in Gherkin `.feature` file for `createRefund` endpoint in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+### Fixed
+* N/A
+
+### Removed
+* `401 - AUTHENTICATION_REQUIRED` error in https://github.com/camaraproject/CarrierBillingCheckOut/pull/229.
+* `403 - CARRIER_BILLING.INVALID_REFUND_CONTEXT` error in https://github.com/camaraproject/CarrierBillingCheckOut/pull/226.
+* Test `@*_403.02_phoneNumber_token_mismatch` in Gherkin `.feature` files in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230.
+
+## New Contributors
+* N/A
+
+
+**Full Changelog**: https://github.com/camaraproject/CarrierBillingCheckOut/compare/r2.2...r3.1
+
 ## r2.2
 
 ## Release Notes
@@ -33,7 +123,7 @@ The API definition(s) are based on
 
 ## 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.**
+**Carrier Billing v0.4.0 is the first public release version for v0.4.0 of the Carrier Billing 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`
@@ -139,7 +229,7 @@ The API definition(s) are based on
 
 ## 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.**
+**Carrier Billing v0.4.0-rc.1 is the first release-candidate version for v0.4.0 of the Carrier Billing 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`
@@ -229,7 +319,7 @@ The API definition(s) are based on
 
 ## 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.**
+**Carrier Billing v0.3.1 is a public release (patch release for v0.3.0) of the Carrier Billing 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
 
@@ -297,7 +387,7 @@ The API definition(s) are based on
 
 ## 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.**
+**Carrier Billing v0.3.0 is the first public release for v0.3.0 of the Carrier Billing 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.
@@ -385,7 +475,7 @@ The API definition(s) are based on
 
 ## 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.**
+**Carrier Billing v0.3.0-rc.1 is the first release-candidate version for v0.3.0 of the Carrier Billing 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.

README.md

@@ -31,19 +31,19 @@ Sandbox API Repository to describe, develop, document, and test the CarrierBilli
 <!-- 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 [r2.2](https://github.com/camaraproject/CarrierBillingCheckout/releases/tag/r2.2) of the Carrier Billing APIs is available.**
-<br>This is a public release.
-
-* The release **r2.2** is available in [r2.2](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r2.2), and includes the following APIs:
-- API name: Carrier Billing (Payment) - API Definition v0.4.0 with inline documentation:
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.2/code/API_definitions/carrier-billing.yaml&nocors)
-  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.2/code/API_definitions/carrier-billing.yaml)
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.2/code/API_definitions/carrier-billing.yaml)
-
-- API name: Carrier Billing Refund - API Definition v0.2.0 with inline documentation:
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.2/code/API_definitions/carrier-billing-refund.yaml&nocors)
-  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r2.2/code/API_definitions/carrier-billing-refund.yaml)
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r2.2/code/API_definitions/carrier-billing-refund.yaml)
+* **The pre-release [r3.1 - rc](https://github.com/camaraproject/CarrierBillingCheckout/releases/tag/r3.1) of the Carrier Billing APIs 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 pre-release **r3.1 - rc** is available in [r3.1](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r3.1), and includes the following APIs:
+- API name: Carrier Billing - API Definition v0.5.0-rc.1 with inline documentation:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.1/code/API_definitions/carrier-billing.yaml)
+
+- API name: Carrier Billing Refund - API Definition v0.3.0-rc.1 with inline documentation:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing-refund.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.1/code/API_definitions/carrier-billing-refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.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)

code/API_definitions/carrier-billing-refund.yaml

@@ -66,8 +66,8 @@ info:
     # Further info and support
 
     (FAQs will be added in a later version of the documentation)
-  version: wip
-  title: Carrier Billing Refunds
+  version: 0.3.0-rc.1
+  title: Carrier Billing Refund
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -76,7 +76,7 @@ externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/CarrierBillingCheckOut
 servers:
-  - url: "{apiRoot}/carrier-billing-refund/vwip"
+  - url: "{apiRoot}/carrier-billing-refund/v0.3rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/API_definitions/carrier-billing.yaml

@@ -26,7 +26,7 @@ info:
 
     This API allows to third party clients to request the payment of a (set of) digital good(s)/service(s), as well as to retrieve information about a specific payment or a list of payments.
 
-    In the scope of **version v0.4, only one-off payments are covered**. Recurrent payments (a.k.a. payment subscriptions) are not covered so far.
+    In the scope of **version v0.5rc1, only one-off payments are covered**. Recurrent payments (a.k.a. payment subscriptions) are not covered so far.
 
     The API provides several endpoints/operations:
     - An endpoint to request a 1-STEP Payment, named `createPayment`.
@@ -136,7 +136,7 @@ info:
     # Further info and support
 
     (FAQs will be added in a later version of the documentation)
-  version: wip
+  version: 0.5.0-rc.1
   title: Carrier Billing
   license:
     name: Apache 2.0
@@ -146,7 +146,7 @@ externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/CarrierBillingCheckOut
 servers:
-  - url: "{apiRoot}/carrier-billing/vwip"
+  - url: "{apiRoot}/carrier-billing/v0.5rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/Test_definitions/carrier-billing-cancelPayment.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Carrier Billing API, v0.4 - Operation cancelPayment
+Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation cancelPayment
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -7,10 +7,10 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation cancelPayment
   # Testing assets:
   # * A phone number eligible for payment (no restrictions for it to be used to perform a payment)
   #
-  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.4.0
+  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.5.0-rc.1
 
   Background: Common cancelPayment setup
-    Given the resource "/carrier-billing/v0.4/payments/{paymentId}/cancel"
+    Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}/cancel"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

code/Test_definitions/carrier-billing-confirmPayment.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Carrier Billing API, v0.4 - Operation confirmPayment
+Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation confirmPayment
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -8,10 +8,10 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation confirmPayment
   # * A phone number eligible for payment (no restrictions for it to be used to perform a payment)
   # * A phone number not-eligible for payment (payment is denied for it due to business conditions)
   #
-  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.4.0
+  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.5.0-rc.1
 
   Background: Common confirmPayment setup
-    Given the resource "/carrier-billing/v0.4/payments/{paymentId}/confirm"
+    Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}/confirm"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

code/Test_definitions/carrier-billing-createPayment.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Carrier Billing API, v0.4 - Operation createPayment
+Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation createPayment
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -8,10 +8,10 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation createPayment
   # * A phone number eligible for payment (no restrictions for it to be used to perform a payment)
   # * A phone number not-eligible for payment (payment is denied for it due to business conditions)
   #
-  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.4.0
+  # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml, version 0.5.0-rc.1
 
   Background: Common createPayment setup
-    Given the resource "/carrier-billing/v0.4/payments"
+    Given the resource "/carrier-billing/v0.5rc1/payments"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"