Merge pull request #167 from camaraproject/r1.1

Release r1.1 (Release Candidate)

CHANGELOG.md

@@ -1,12 +1,94 @@
-# Changelog CarrierBillingCheckOut
+# Changelog CarrierBillingCheckOut API Family
 
 ## Table of Contents
 
-- [v0.2.1](#v0.2.1)
-- [v0.2.0](#v0.2.0)
+- [r1.1 - rc](#r11---rc)
+- [v0.2.1](#v021)
+- [v0.2.0](#v020)
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
 
+The below sections record the changes for each API version in each release as follows:
+
+* for each first alpha or release-candidate API version, all changes since the release of the previous public API version
+* 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.1 - rc
+
+## Release Notes
+
+This release contains the definition and documentation of
+* Carrier Billing v0.3.0-rc.1
+* Carrier Billing Refund v0.1.0-rc.1
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+## 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.**
+- **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.
+  - Version designed to work jointly with Carrier Billing Refund API
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.1/code/API_definitions/carrier_billing.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.1/code/API_definitions/carrier_billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.1/code/API_definitions/carrier_billing.yaml)
+
+### Added
+* N/A
+
+### Changed
+* Support for non-negative `amount` and `taxAmount` values in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+* Adoption of CloudEvents Subscription Model replacing `webhook` by `sink` and `sinkCredential` concepts as well as aligning callback endpoint for notifications in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+* Aligment of Exceptions with Commonalities MetaRelease Fall24 in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+* Alignment of Authorization and authentication section with I&CM MetaRelease Fall24 in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+
+### Fixed
+* Clarifications on descriptions and editorial enhancements in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+
+### Removed
+* N/A
+
+## Carrier Billing Refund v0.1.0-rc.1
+
+**Carrier Billing Refund v0.1.0-rc.1 is the first release-candidate version for v0.1.0 of the Carrier Billing Refund API.**
+- **This version defines a new API:**
+  - Initial version covering the following functionality and related endpoints:
+    - New endpoint `createRefund`, both total and partial refunds
+    - New endpoint `retrieveRefunds`
+    - New endpoint `retrieveRefund`
+    - New endpoint `retrievePaymentRemainingAmount`
+    - Support for `Instance-based (implicit) subscription` notification mode
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.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/r1.1/code/API_definitions/carrier_billing_refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.1/code/API_definitions/carrier_billing_refund.yaml)
+
+### Added
+* Added new Carrier Billing Refund API with the functionality aforementioned indicated (create a refund, query details of a given refund or a list of refunds, retrieve the amount not yet refunded of a given payment, support for implicit-based subscription) in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+* Aligned with Commonalities and I&CM MetaRelease Fall24 in https://github.com/camaraproject/CarrierBillingCheckOut/pull/152
+
+### Changed
+* N/A
+
+### Fixed
+* N/A
+
+### Removed
+* N/A
+
+## New Contributors
+* N/A
+
+
+**Full Changelog**: https://github.com/camaraproject/CarrierBillingCheckOut/compare/v0.2.1...r1.1---rc
+
 ## v0.2.1
 
 **Fix over the first release**

README.md

@@ -24,8 +24,27 @@ Repository to describe, develop, document and test the CarrierBilling API family
   * Bi-Weekly, Wednesdays 16:00 - 17:00 CET/CEST
 * Meeting link: [Link](https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2UzOTNhOWItMmNkNC00NDVjLWIzYjAtYzgxNDBkOGY2MjFi%40thread.v2/0?context=%7b%22Tid%22%3a%229744600e-3e04-492e-baa1-25ec245c6f10%22%2c%22Oid%22%3a%2219764050-b5d5-4991-9f15-d10905a94c08%22%7d)
 
-## Results
-* Sub Project is in progress
+## Status and released versions
+* **The Release [r1.1 - rc](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md#r1.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 **r1.1 - rc** is available in [r1.1](https://github.com/camaraproject/CarrierBillingCheckOut/tree/r1.1), and includes the following APIs:
+- API name: Carrier Billing (Payment) - 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/r1.1/code/API_definitions/carrier_billing.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.1/code/API_definitions/carrier_billing.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.1/code/API_definitions/carrier_billing.yaml)
+
+- API name: Carrier Billing Refund - API Definition v0.1.0-rc.1 with inline documentation:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r1.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/r1.1/code/API_definitions/carrier_billing_refund.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r1.1/code/API_definitions/carrier_billing_refund.yaml)
+
+* For changes between r1.1 and v0.2.1 see the [CHANGELOG.md](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md)
+
+* **The latest available and released version 0.2.1 is available within the [release-0.2.1 branch](https://github.com/camaraproject/CarrierBillingCheckOut/tree/release-v0.2.1)**
+  - API name: Carrier Billing (Payment) - API Definition v0.2.1 with inline documentation:
+    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/release-v0.2.1/code/API_definitions/carrier_billing.yaml&nocors)
+    - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/release-v0.2.1/code/API_definitions/carrier_billing.yaml)
+    - OpenAPI [YAML spec file](https://github.com/camaraproject/CarrierBillingCheckOut/blob/release-v0.2.1/code/API_definitions/carrier_billing.yaml)
 
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-cbc>.

code/API_definitions/carrier_billing.yaml

@@ -99,7 +99,7 @@ info:
 
     # Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -108,11 +108,8 @@ info:
     # Further info and support
 
     (FAQs will be added in a later version of the documentation)
-  version: 0.3.0-wip
+  version: 0.3.0-rc.1
   title: Carrier Billing
-  termsOfService: http://swagger.io/terms/
-  contact:
-    email: [email protected]
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -121,7 +118,7 @@ externalDocs:
   url: https://github.com/camaraproject/
 x-camara-commonalities: 0.4.0
 servers:
-  - url: "{apiRoot}/carrier-billing/v0.3"
+  - url: "{apiRoot}/carrier-billing/v0.3rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/API_definitions/carrier_billing_refund.yaml

@@ -43,7 +43,7 @@ info:
 
     # Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -52,11 +52,8 @@ info:
     # Further info and support
 
     (FAQs will be added in a later version of the documentation)
-  version: 0.1.0-wip
+  version: 0.1.0-rc.1
   title: Carrier Billing Refunds
-  termsOfService: http://swagger.io/terms/
-  contact:
-    email: [email protected]
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -65,7 +62,7 @@ externalDocs:
   url: https://github.com/camaraproject/
 x-camara-commonalities: 0.4.0
 servers:
-  - url: "{apiRoot}/carrier-billing-refund/v0.1"
+  - url: "{apiRoot}/carrier-billing-refund/v0.1rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md

@@ -10,7 +10,7 @@ Checklist for Carrier Billing Refund v0.1.0-rc.1 in r1.1
 |  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |  Y   |      |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | link |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   | link |
-|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  N   | link |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  tbd   | link |
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
 |  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
 | 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |

documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md

@@ -10,7 +10,7 @@ Checklist for Carrier Billing v0.3.0-rc.1 in r1.1.
 |  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |  Y   |      |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | link |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | link |
-|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  N   | link |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  tbd   | link |
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
 |  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
 | 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |