From 5043def3d9df65455bee98abecafd1b7056fb1c6 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Fri, 22 Aug 2025 13:58:19 +0200 Subject: [PATCH 1/4] Public Release r3.2 for CarrierBillingCheckout APIs (Fall25 M4) --- CHANGELOG.md | 92 +++++++++++++++++++ README.md | 26 +++--- .../carrier-billing-refund.yaml | 4 +- code/API_definitions/carrier-billing.yaml | 4 +- .../carrier-billing-cancelPayment.feature | 4 +- .../carrier-billing-confirmPayment.feature | 4 +- .../carrier-billing-createPayment.feature | 4 +- .../carrier-billing-preparePayment.feature | 4 +- ...arrier-billing-refund-createRefund.feature | 4 +- ...und-retrievePaymentRemainingAmount.feature | 4 +- ...rier-billing-refund-retrieveRefund.feature | 4 +- ...ier-billing-refund-retrieveRefunds.feature | 4 +- .../carrier-billing-retrievePayment.feature | 4 +- .../carrier-billing-retrievePayments.feature | 4 +- .../carrier-billing-validatePayment.feature | 4 +- ...carrier-billing-API-Readiness-Checklist.md | 6 +- ...-billing-refund-API-Readiness-Checklist.md | 6 +- 17 files changed, 137 insertions(+), 45 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21d0100..f2f21de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r3.2](#r32) - [r3.1 - rc](#r31---rc) - [r2.2](#r22) - [r2.1 - rc](#r21---rc) @@ -20,6 +21,97 @@ 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.2 + +## Release Notes + +This release contains the definition and documentation of +* Carrier Billing v0.5.0 +* Carrier Billing Refund v0.3.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## Carrier Billing v0.5.0 + +**Carrier Billing v0.5.0 is the first public release 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.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/r3.2/code/API_definitions/carrier-billing.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/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 and https://github.com/camaraproject/CarrierBillingCheckOut/pull/236. +* Update test for invalid sink in Gherkin `.feature` files for `createPayment` and `preparePayment` endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230. +* Error schema model alignment with Commonalities in https://github.com/camaraproject/CarrierBillingCheckOut/pull/236. + +### 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 + +**Carrier Billing Refund v0.3.0 is the first public release 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.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/r3.2/code/API_definitions/carrier-billing-refund.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/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 and https://github.com/camaraproject/CarrierBillingCheckOut/pull/236. +* Update test for invalid sink in Gherkin `.feature` file for `createRefund` endpoint in https://github.com/camaraproject/CarrierBillingCheckOut/pull/230. +* Error schema model alignment with Commonalities in https://github.com/camaraproject/CarrierBillingCheckOut/pull/236. + +### 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.2 + ## r3.1 - rc ## Release Notes diff --git a/README.md b/README.md index 25575ca..448e922 100644 --- a/README.md +++ b/README.md @@ -31,19 +31,19 @@ Sandbox API Repository to describe, develop, document, and test the CarrierBilli * 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 pre-release [r3.1 - rc](https://github.com/camaraproject/CarrierBillingCheckout/releases/tag/r3.1) of the Carrier Billing APIs is available.** -
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) +* **The release [r3.2](https://github.com/camaraproject/CarrierBillingCheckout/releases/tag/r3.2) of the Carrier Billing APIs is available.** +
This is a public release. + +* The release **r3.2** is available in [r3.2](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r3.2), and includes the following APIs: +- API name: Carrier Billing - API Definition v0.5.0 with inline documentation: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.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/r3.2/code/API_definitions/carrier-billing.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/code/API_definitions/carrier-billing.yaml) + +- API name: Carrier Billing Refund - API Definition v0.3.0 with inline documentation: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.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/r3.2/code/API_definitions/carrier-billing-refund.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/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) diff --git a/code/API_definitions/carrier-billing-refund.yaml b/code/API_definitions/carrier-billing-refund.yaml index 5003f80..8b75e24 100644 --- a/code/API_definitions/carrier-billing-refund.yaml +++ b/code/API_definitions/carrier-billing-refund.yaml @@ -66,7 +66,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: 0.3.0-rc.1 + version: 0.3.0 title: Carrier Billing Refund license: name: Apache 2.0 @@ -76,7 +76,7 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/CarrierBillingCheckOut servers: - - url: "{apiRoot}/carrier-billing-refund/v0.3rc1" + - url: "{apiRoot}/carrier-billing-refund/v0.3" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/carrier-billing.yaml b/code/API_definitions/carrier-billing.yaml index 58b4773..113698f 100644 --- a/code/API_definitions/carrier-billing.yaml +++ b/code/API_definitions/carrier-billing.yaml @@ -136,7 +136,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: 0.5.0-rc.1 + version: 0.5.0 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/v0.5rc1" + - url: "{apiRoot}/carrier-billing/v0.5" variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/carrier-billing-cancelPayment.feature b/code/Test_definitions/carrier-billing-cancelPayment.feature index d072c34..a3da01c 100644 --- a/code/Test_definitions/carrier-billing-cancelPayment.feature +++ b/code/Test_definitions/carrier-billing-cancelPayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation cancelPayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation cancelPayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -10,7 +10,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation cancelPayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common cancelPayment setup - Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}/cancel" + Given the resource "/carrier-billing/v0.5/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" diff --git a/code/Test_definitions/carrier-billing-confirmPayment.feature b/code/Test_definitions/carrier-billing-confirmPayment.feature index 1e0c843..d4db9a1 100644 --- a/code/Test_definitions/carrier-billing-confirmPayment.feature +++ b/code/Test_definitions/carrier-billing-confirmPayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation confirmPayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation confirmPayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation confirmPayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common confirmPayment setup - Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}/confirm" + Given the resource "/carrier-billing/v0.5/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" diff --git a/code/Test_definitions/carrier-billing-createPayment.feature b/code/Test_definitions/carrier-billing-createPayment.feature index bbcbc8f..6ce9dbe 100644 --- a/code/Test_definitions/carrier-billing-createPayment.feature +++ b/code/Test_definitions/carrier-billing-createPayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation createPayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation createPayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation createPayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common createPayment setup - Given the resource "/carrier-billing/v0.5rc1/payments" + Given the resource "/carrier-billing/v0.5/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" diff --git a/code/Test_definitions/carrier-billing-preparePayment.feature b/code/Test_definitions/carrier-billing-preparePayment.feature index fce4657..7f32a0c 100644 --- a/code/Test_definitions/carrier-billing-preparePayment.feature +++ b/code/Test_definitions/carrier-billing-preparePayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation preparePayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation preparePayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation preparePayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common preparePayment setup - Given the resource "/carrier-billing/v0.5rc1/payments/prepare" + Given the resource "/carrier-billing/v0.5/payments/prepare" 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" diff --git a/code/Test_definitions/carrier-billing-refund-createRefund.feature b/code/Test_definitions/carrier-billing-refund-createRefund.feature index 0017cea..45bbbe7 100644 --- a/code/Test_definitions/carrier-billing-refund-createRefund.feature +++ b/code/Test_definitions/carrier-billing-refund-createRefund.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation createRefund +Feature: CAMARA Carrier Billing Refund API, v0.3.0 - Operation createRefund # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation createRefund # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml Background: Common createRefund setup - Given the resource "/carrier-billing-refund/v0.3rc1/refunds" + Given the resource "/carrier-billing-refund/v0.3/refunds" 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" diff --git a/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature b/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature index 5851d84..0bcc665 100644 --- a/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature +++ b/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrievePaymentRemainingAmount +Feature: CAMARA Carrier Billing Refund API, v0.3.0 - Operation retrievePaymentRemainingAmount # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrievePaym # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml Background: Common retrievePaymentRemainingAmount setup - Given the resource "/carrier-billing-refund/v0.3rc1/payments/{paymentId}/refunds/remaining-amount" + Given the resource "/carrier-billing-refund/v0.3/payments/{paymentId}/refunds/remaining-amount" 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" diff --git a/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature b/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature index a410f08..dc59803 100644 --- a/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature +++ b/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrieveRefund +Feature: CAMARA Carrier Billing Refund API, v0.3.0 - Operation retrieveRefund # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrieveRefu # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml Background: Common retrieveRefund setup - Given the resource "/carrier-billing-refund/v0.3rc1/payments/{paymentId}/refunds/{refundId}" + Given the resource "/carrier-billing-refund/v0.3/payments/{paymentId}/refunds/{refundId}" 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" diff --git a/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature b/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature index 6f705c4..2e4426d 100644 --- a/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature +++ b/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrieveRefunds +Feature: CAMARA Carrier Billing Refund API, v0.3.0 - Operation retrieveRefunds # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.3.0-rc.1 - Operation retrieveRefu # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml Background: Common retrievePayment setup - Given the resource "/carrier-billing-refund/v0.3rc1/payments/{paymentId}/refunds" + Given the resource "/carrier-billing-refund/v0.3/payments/{paymentId}/refunds" 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" diff --git a/code/Test_definitions/carrier-billing-retrievePayment.feature b/code/Test_definitions/carrier-billing-retrievePayment.feature index 9dbf6d0..3586d80 100644 --- a/code/Test_definitions/carrier-billing-retrievePayment.feature +++ b/code/Test_definitions/carrier-billing-retrievePayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation retrievePayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation retrievePayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation retrievePayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common retrievePayment setup - Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}" + Given the resource "/carrier-billing/v0.5/payments/{paymentId}" 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" diff --git a/code/Test_definitions/carrier-billing-retrievePayments.feature b/code/Test_definitions/carrier-billing-retrievePayments.feature index dd88446..a2394a1 100644 --- a/code/Test_definitions/carrier-billing-retrievePayments.feature +++ b/code/Test_definitions/carrier-billing-retrievePayments.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation retrievePayments +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation retrievePayments # Input to be provided by the implementation to the tester # # Implementation indications: @@ -11,7 +11,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation retrievePayments # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common retrievePayments setup - Given the resource "/carrier-billing/v0.5rc1/payments" + Given the resource "/carrier-billing/v0.5/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" diff --git a/code/Test_definitions/carrier-billing-validatePayment.feature b/code/Test_definitions/carrier-billing-validatePayment.feature index 046caf2..b432c1a 100644 --- a/code/Test_definitions/carrier-billing-validatePayment.feature +++ b/code/Test_definitions/carrier-billing-validatePayment.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation validatePayment +Feature: CAMARA Carrier Billing API, v0.5.0 - Operation validatePayment # Input to be provided by the implementation to the tester # # Implementation indications: @@ -10,7 +10,7 @@ Feature: CAMARA Carrier Billing API, v0.5.0-rc.1 - Operation validatePayment # References to OAS spec schemas refer to schemas specifies in carrier-billing.yaml Background: Common validatePayment setup - Given the resource "/carrier-billing/v0.5rc1/payments/{paymentId}/validate" + Given the resource "/carrier-billing/v0.5/payments/{paymentId}/validate" 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" diff --git a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md index 6ec0647..9d74979 100644 --- a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md @@ -1,12 +1,12 @@ # API Readiness Checklist -Checklist for Carrier Billing v0.5.0-rc.1 in r3.1 +Checklist for Carrier Billing v0.5.0 in r3.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/carrier-billing.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | [link](/code/API_definitions/carrier-billing.yaml) | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/Carrier Billing User Story.md) | diff --git a/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md b/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md index c857593..010281a 100644 --- a/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md @@ -1,12 +1,12 @@ # API Readiness Checklist -Checklist for Carrier Billing Refund v0.3.0-rc.1 in r3.1 +Checklist for Carrier Billing Refund v0.3.0 in r3.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/carrier-billing-refund.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | [link](/code/API_definitions/carrier-billing-refund.yaml) | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/Carrier Billing Refund User Story.md) | From 3fcea2e3636162fd0bbc7df1fb5afc5a15a6f07e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Thu, 4 Sep 2025 08:22:41 +0200 Subject: [PATCH 2/4] Update CHANGELOG.md Co-authored-by: Jose Luis Urien --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f2f21de..f37f3b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,7 @@ The below sections record the changes for each API version in each release as fo ## Release Notes -This release contains the definition and documentation of +This public release contains the definition and documentation of * Carrier Billing v0.5.0 * Carrier Billing Refund v0.3.0 From c4c76e87f7199596e1687804dc90e6a353ef2c3b Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Thu, 4 Sep 2025 08:28:18 +0200 Subject: [PATCH 3/4] updates_after_1st_rm_review --- code/API_definitions/carrier-billing-refund.yaml | 4 ++-- code/API_definitions/carrier-billing.yaml | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/carrier-billing-refund.yaml b/code/API_definitions/carrier-billing-refund.yaml index 8b75e24..1efa99b 100644 --- a/code/API_definitions/carrier-billing-refund.yaml +++ b/code/API_definitions/carrier-billing-refund.yaml @@ -1244,7 +1244,7 @@ components: Client indicates content that is understable by the Server but unable to be processed. Scenarios considered: - Unauthorized refund amount requested ("code": "CARRIER_BILLING_REFUND.UNAUTHORIZED_AMOUNT","message": "Unauthorized amount requested."). - - Accumulated threshold refund amount for the user's mobile account overpassed ("code": "CARRIER_BILLING_REFUND.USER_AMOUNT_THRESHOLD_OVERPASSED","message": "Unathorized refund request. Accumulated user mobile refunds overpass account amount threshold."). + - Accumulated threshold refund amount for the user's mobile account overpassed ("code": "CARRIER_BILLING_REFUND.USER_AMOUNT_THRESHOLD_OVERPASSED","message": "Unauthorized refund request. Accumulated user mobile refunds overpass account amount threshold."). - Payment is not in suitable status for refund ("code": "CARRIER_BILLING_REFUND.INVALID_PAYMENT_STATUS","message": "Payment is not yet completed."). - Property `isTaxIncluded` has not the same value as related Payment ("code": "CARRIER_BILLING_REFUND.TAXES_MANAGEMENT_MISMATCH","message": "Inconsistent isTaxIncluded value with regards to related payment."). - Refund details provided are inconsistent with regards to the related Payment ("code": "CARRIER_BILLING_REFUND.REFUND_DETAILS_MISMATCH","message": "Inconsistent refundDetails information with regards to related payment."). @@ -1282,7 +1282,7 @@ components: value: status: 422 code: CARRIER_BILLING_REFUND.USER_AMOUNT_THRESHOLD_OVERPASSED - message: "Unathorized refund request. Accumulated user mobile payments overpass account amount threshold." + message: "Unauthorized refund request. Accumulated user mobile payments overpass account amount threshold." GENERIC_422_INVALID_PAYMENT_STATUS: summary: Generic Invalid Payment Status description: Payment is not in suitable status for refund diff --git a/code/API_definitions/carrier-billing.yaml b/code/API_definitions/carrier-billing.yaml index 113698f..7dddd38 100644 --- a/code/API_definitions/carrier-billing.yaml +++ b/code/API_definitions/carrier-billing.yaml @@ -46,10 +46,10 @@ info: - **Notification URL**: Developers may provide a callback URL (`sink` param) on which status change notifications, regarding the payment, can be received from the Telco Operator. This is an optional parameter. Following diagram shows the API resources operation sequencing: - ![PaymentSequence](https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/main/documentation/API_documentation/resources/Carrier_Billing_sequence_diagram.png) + ![PaymentSequence](https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/documentation/API_documentation/resources/Carrier_Billing_sequence_diagram.png) Follow picture provides information about the payment state engine (state description & transition): - ![Payment State Engine](https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/main/documentation/API_documentation/resources/Carrier_Billing_State_Engine.JPG) + ![Payment State Engine](https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/documentation/API_documentation/resources/Carrier_Billing_State_Engine.JPG) State transitions: @@ -2078,7 +2078,7 @@ components: - An identifier is not included in the request and the device or phone number identification cannot be derived from the 3-legged access token ("code": "MISSING_IDENTIFIER","message": "The phone number cannot be identified.") - An explicit identifier is provided when a device or phone number has already been identified from the access token ("code": "UNNECESSARY_IDENTIFIER","message": "The phone number is already identified by the access token.") - Unauthorized amount requested ("code": "CARRIER_BILLING.UNAUTHORIZED_AMOUNT","message": "Unauthorized amount requested."). - - Accumulated threshold amount for the user's mobile account overpassed ("code": "CARRIER_BILLING.USER_AMOUNT_THRESHOLD_OVERPASSED","message": "Unathorized payment request. Accumulated user mobile payments overpass account amount threshold."). + - Accumulated threshold amount for the user's mobile account overpassed ("code": "CARRIER_BILLING.USER_AMOUNT_THRESHOLD_OVERPASSED","message": "Unauthorized payment request. Accumulated user mobile payments overpass account amount threshold."). headers: x-correlator: $ref: "#/components/headers/x-correlator" @@ -2131,7 +2131,7 @@ components: value: status: 422 code: CARRIER_BILLING.USER_AMOUNT_THRESHOLD_OVERPASSED - message: "Unathorized payment request. Accumulated user mobile payments overpass account amount threshold." + message: "Unauthorized payment request. Accumulated user mobile payments overpass account amount threshold." PaymentSecondStepUnprocessable422: description: |- Client indicates content that is understable by the Server but unable to be processed. From 55b8c79aabbbbbd6ff63b57439cef7e9cae624ff Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Fri, 5 Sep 2025 17:39:27 +0200 Subject: [PATCH 4/4] error_info_schema_aligment --- code/API_definitions/carrier-billing-refund.yaml | 8 ++++---- code/API_definitions/carrier-billing.yaml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/carrier-billing-refund.yaml b/code/API_definitions/carrier-billing-refund.yaml index 1efa99b..8afa0ce 100644 --- a/code/API_definitions/carrier-billing-refund.yaml +++ b/code/API_definitions/carrier-billing-refund.yaml @@ -898,19 +898,19 @@ components: ErrorInfo: type: object required: - - message - status - code + - message properties: - message: - type: string - description: A human-readable description of what the event represents status: type: integer description: HTTP response status code code: type: string description: A human-readable code to describe the error + message: + type: string + description: A human-readable description of what the event represents responses: Generic400: description: Invalid input diff --git a/code/API_definitions/carrier-billing.yaml b/code/API_definitions/carrier-billing.yaml index 7dddd38..e253ca2 100644 --- a/code/API_definitions/carrier-billing.yaml +++ b/code/API_definitions/carrier-billing.yaml @@ -1354,19 +1354,19 @@ components: ErrorInfo: type: object required: - - message - status - code + - message properties: - message: - type: string - description: A human-readable description of what the event represents status: type: integer description: HTTP response status code code: type: string description: A human-readable code to describe the error + message: + type: string + description: A human-readable description of what the event represents responses: Generic400: description: Bad Request