Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release r2.1 (Release Candidate) #202

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Release r2.1 (Release Candidate) #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
105a4a9
Release r2.1 (Release Candidate)
PedroDiez Jan 14, 2025
613dd65
reference_PR
PedroDiez Jan 14, 2025
98cd896
fix_linter_error_409
PedroDiez Jan 14, 2025
ce8fd02
fix_editorial_typo
PedroDiez Jan 14, 2025
1257eac
fix_api_readiness_checklist
PedroDiez Jan 14, 2025
9a5bb9e
test_plan_editorial_updates
PedroDiez Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Table of Contents

- [r2.1 - rc](#r21---rc)
- [r1.3](#r13)
- [r1.2](#r12)
- [r1.1 - rc](#r11---rc)
Expand All @@ -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 in https://github.com/camaraproject/CarrierBillingCheckOut/pull/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 https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added applicable `422` traversal exceptions in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added `429 - TOO_MANY_REQUESTS` to API endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added Gherkin Testing Linter in https://github.com/camaraproject/CarrierBillingCheckOut/pull/191.

### Changed
* Updated `# Authorization and authentication` section from ICM guideline in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Error model aligment with commonalities. Normalization values (i.e. enums) for `status` and `code`. In https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Updated testing plan in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.

### Fixed
* Updated `accessTokenExpiresUtc` description in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Some clarifications on descriptions in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.

### Removed
* Removed `403 - INVALID_TOKEN_CONTEXT` in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Removed `5XX` errors in https://github.com/camaraproject/CarrierBillingCheckOut/pull/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**:
- [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 in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added applicable `422` traversal exceptions in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added `429 - TOO_MANY_REQUESTS` to API endpoints in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Added Gherkin Testing Linter in https://github.com/camaraproject/CarrierBillingCheckOut/pull/191.

### Changed
* Updated `# Authorization and authentication` section from ICM guideline in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Error model aligment with commonalities. Normalization values (i.e. enums) for `status` and `code`. In https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Updated testing plan in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.

### Fixed
* Updated `accessTokenExpiresUtc` description in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Some clarifications on descriptions in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.

### Removed
* Removed `403 - INVALID_TOKEN_CONTEXT` in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.
* Removed `5XX` errors in https://github.com/camaraproject/CarrierBillingCheckOut/pull/202.

## New Contributors
* N/A


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

## r1.3

## Release Notes
Expand Down
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading
Loading