From 643759a9a28cfd25723f0fe49b540b8e025013a2 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Fri, 15 Nov 2024 16:06:01 +0100 Subject: [PATCH] Public Release r1.3 --- CHANGELOG.md | 69 +++++++++++++++++++ README.md | 24 +++---- ...carrier-billing-API-Readiness-Checklist.md | 2 +- ...-billing-refund-API-Readiness-Checklist.md | 2 +- 4 files changed, 83 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00d3223..a0058b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r1.3](#r13) - [r1.2](#r12) - [r1.1 - rc](#r11---rc) - [v0.2.1](#v021) @@ -15,6 +16,74 @@ 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 +## 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**: + - [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) + +**Main changes since [r1.2](#r12)** + +### Added +* New section `# Generic Clarification about optional parameters` within API Spec `info.description` field in https://github.com/camaraproject/CarrierBillingCheckOut/pull/183 + +### Changed +* Update `README.md` with new wiki domain for the Sub-project in https://github.com/camaraproject/CarrierBillingCheckOut/pull/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**: + - [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) + +**Main changes since [r1.2](#r12)** + +### Added +* New section `# Generic Clarification about optional parameters` within API Spec `info.description` field in https://github.com/camaraproject/CarrierBillingCheckOut/pull/183 + +### Changed +* Update `README.md` with new wiki domain for the Sub-project in https://github.com/camaraproject/CarrierBillingCheckOut/pull/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 diff --git a/README.md b/README.md index 58b271b..fc14306 100644 --- a/README.md +++ b/README.md @@ -26,26 +26,26 @@ Repository to describe, develop, document and test the CarrierBilling API family * 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.2](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md#r1.2) for the Carrier Billing APIs Family is available.** -
This is a public release candidate. +* **The Release [r1.3](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md#r1.3) for the Carrier Billing APIs Family is available.** +
This is a public release. -* The release **r1.2** is available in [r1.2](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r1.2), and includes the following APIs: -- API name: Carrier Billing (Payment) - API Definition v0.3.0 with inline documentation: - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.2/code/API_definitions/carrier-billing.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.2/code/API_definitions/carrier-billing.yaml) - - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.2/code/API_definitions/carrier-billing.yaml) +* 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.0 with inline documentation: - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.2/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.2/code/API_definitions/carrier-billing-refund.yaml) - - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.2/code/API_definitions/carrier-billing-refund.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) * 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) ## Contributing * Meetings are held virtually - * Schedule: Bi-Weekly, Wednesdays 15:00 - 16:00 CET/CEST + * Schedule: Bi-Weekly, Wednesdays 13:00 - 14:00 UTC * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96513497117?password=ac26d34b-87d2-4d78-aa47-4de1ca14c882) * Minutes: Access [Meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/CDDe) * Mailing List diff --git a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md index c6128a4..89488a0 100644 --- a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for Carrier Billing v0.3.0 in r1.2 +Checklist for Carrier Billing v0.3.1 in r1.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| 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 650ec51..e94863e 100644 --- a/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for Carrier Billing Refund v0.1.0 in r1.2 +Checklist for Carrier Billing Refund v0.1.1 in r1.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|