diff --git a/CHANGELOG.md b/CHANGELOG.md index 521a3d3..8d27d7c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,7 @@ This release contains the definition and documentation of * Carrier Billing Refund v0.2.0-rc.1 The API definition(s) are based on -* Commonalities v0.5.0-alpha.1 +* Commonalities v0.5.0-rc.1 * Identity and Consent Management v0.3.0-alpha.1 ## Carrier Billing v0.4.0-rc.1 diff --git a/code/API_definitions/carrier-billing-refund.yaml b/code/API_definitions/carrier-billing-refund.yaml index 3c0dbf3..a9f65c4 100644 --- a/code/API_definitions/carrier-billing-refund.yaml +++ b/code/API_definitions/carrier-billing-refund.yaml @@ -66,7 +66,7 @@ info: externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/CarrierBillingCheckOut -x-camara-commonalities: 0.5.0 +x-camara-commonalities: 0.5 servers: - url: "{apiRoot}/carrier-billing-refund/v0.2rc1" variables: @@ -1364,11 +1364,11 @@ components: examples: GENERIC_429_TOO_MANY_REQUESTS: summary: Generic Too Many Requests - description: API Server request limit is overpassed + description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached value: status: 429 code: TOO_MANY_REQUESTS - message: Either out of resource quota or reaching rate limiting. + message: Rate limit reached. parameters: x-correlator: name: x-correlator @@ -1376,6 +1376,8 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ + example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" Page: name: page in: query @@ -1442,6 +1444,7 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ Content-Last-Key: description: Indicates the index of the last result provided in the response schema: diff --git a/code/API_definitions/carrier-billing.yaml b/code/API_definitions/carrier-billing.yaml index 5dbc1ce..73b2d4e 100644 --- a/code/API_definitions/carrier-billing.yaml +++ b/code/API_definitions/carrier-billing.yaml @@ -136,7 +136,7 @@ info: externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/CarrierBillingCheckOut -x-camara-commonalities: 0.5.0 +x-camara-commonalities: 0.5 servers: - url: "{apiRoot}/carrier-billing/v0.4rc1" variables: @@ -2155,11 +2155,11 @@ components: examples: GENERIC_429_TOO_MANY_REQUESTS: summary: Generic Too Many Requests - description: API Server request limit is overpassed + description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached value: status: 429 code: TOO_MANY_REQUESTS - message: Either out of resource quota or reaching rate limiting. + message: Rate limit reached. parameters: x-correlator: name: x-correlator @@ -2167,6 +2167,8 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ + example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" Page: name: page in: query @@ -2236,6 +2238,7 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ Content-Last-Key: description: Indicates the index of the last result provided in the response schema: diff --git a/code/Test_definitions/README.md b/code/Test_definitions/README.md deleted file mode 100644 index 27a1f06..0000000 --- a/code/Test_definitions/README.md +++ /dev/null @@ -1 +0,0 @@ -This directory contains at least one `.feature` file containing test definitions for the repository API(s). diff --git a/code/Test_definitions/carrier-billing-cancelPayment.feature b/code/Test_definitions/carrier-billing-cancelPayment.feature index 2159da0..790b3c1 100644 --- a/code/Test_definitions/carrier-billing-cancelPayment.feature +++ b/code/Test_definitions/carrier-billing-cancelPayment.feature @@ -7,7 +7,7 @@ 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.4.0-rc.1 Background: Common cancelPayment setup Given the resource "/carrier-billing/v0.4/payments/{paymentId}/cancel" @@ -74,7 +74,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation cancelPayment @cancel_payment_C02.01_phone_number_not_schema_compliant Scenario: Phone number value does not comply with the schema - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" does not comply with the OAS schema at "/components/schemas/PhoneNumber" When the HTTP "POST" request is sent Then the response status code is 400 @@ -166,7 +166,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation cancelPayment And the response property "$.message" contains a user friendly text @cancel_payment_C02.03_unnecessary_phone_number - Scenario: Phone number not to included when can be deducted from the access token + Scenario: Phone number not to be included when it can be deduced from the access token Given the header "Authorization" is set to a valid access token identifying a phone number And the request body property "$.phoneNumber" is set to a valid phone number When the HTTP "POST" request is sent @@ -177,7 +177,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation cancelPayment @cancel_payment_C02.04_missing_phone_number Scenario: Phone number not included and cannot be deducted from the access token - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" is not included When the HTTP "POST" request is sent Then the response status code is 422 diff --git a/code/Test_definitions/carrier-billing-confirmPayment.feature b/code/Test_definitions/carrier-billing-confirmPayment.feature index a36cc9c..08ad71a 100644 --- a/code/Test_definitions/carrier-billing-confirmPayment.feature +++ b/code/Test_definitions/carrier-billing-confirmPayment.feature @@ -8,7 +8,7 @@ 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.4.0-rc.1 Background: Common confirmPayment setup Given the resource "/carrier-billing/v0.4/payments/{paymentId}/confirm" @@ -75,7 +75,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation confirmPayment @confirm_payment_C02.01_phone_number_not_schema_compliant Scenario: Phone number value does not comply with the schema - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" does not comply with the OAS schema at "/components/schemas/PhoneNumber" When the HTTP "POST" request is sent Then the response status code is 400 @@ -178,7 +178,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation confirmPayment And the response property "$.message" contains a user friendly text @confirm_payment_C02.03_unnecessary_phone_number - Scenario: Phone number not to included when can be deducted from the access token + Scenario: Phone number not to be included when it can be deduced from the access token Given the header "Authorization" is set to a valid access token identifying a phone number And the request body property "$.phoneNumber" is set to a valid phone number When the HTTP "POST" request is sent @@ -189,7 +189,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation confirmPayment @confirm_payment_C02.04_missing_phone_number Scenario: Phone number not included and cannot be deducted from the access token - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" is not included When the HTTP "POST" request is sent Then the response status code is 422 diff --git a/code/Test_definitions/carrier-billing-createPayment.feature b/code/Test_definitions/carrier-billing-createPayment.feature index bcd9001..26c54e2 100644 --- a/code/Test_definitions/carrier-billing-createPayment.feature +++ b/code/Test_definitions/carrier-billing-createPayment.feature @@ -8,7 +8,7 @@ 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.4.0-rc.1 Background: Common createPayment setup Given the resource "/carrier-billing/v0.4/payments" @@ -276,7 +276,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation createPayment @create_payment_C02.01_phone_number_not_schema_compliant Scenario: Phone number value does not comply with the schema - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" does not comply with the OAS schema at "/components/schemas/PhoneNumber" When the HTTP "POST" request is sent Then the response status code is 400 @@ -393,7 +393,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation createPayment And the response property "$.message" contains a user friendly text @create_payment_C02.03_unnecessary_phone_number - Scenario: Phone number not to included when can be deducted from the access token + Scenario: Phone number not to be included when it can be deduced from the access token Given the header "Authorization" is set to a valid access token identifying a phone number And the request body property "$.phoneNumber" is set to a valid phone number When the HTTP "POST" request is sent @@ -404,7 +404,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation createPayment @create_payment_C02.04_missing_phone_number Scenario: Phone number not included and cannot be deducted from the access token - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" is not included When the HTTP "POST" request is sent Then the response status code is 422 diff --git a/code/Test_definitions/carrier-billing-preparePayment.feature b/code/Test_definitions/carrier-billing-preparePayment.feature index 100ccdf..c2eb6b2 100644 --- a/code/Test_definitions/carrier-billing-preparePayment.feature +++ b/code/Test_definitions/carrier-billing-preparePayment.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation preparePayment # * 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.4.0-rc.1 Background: Common preparePayment setup Given the resource "/carrier-billing/v0.4/payments/prepare" @@ -289,7 +289,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation preparePayment @prepare_payment_C02.01_phone_number_not_schema_compliant Scenario: Phone number value does not comply with the schema - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" does not comply with the OAS schema at "/components/schemas/PhoneNumber" When the HTTP "POST" request is sent Then the response status code is 400 @@ -406,7 +406,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation preparePayment And the response property "$.message" contains a user friendly text @prepare_payment_C02.03_unnecessary_phone_number - Scenario: Phone number not to included when can be deducted from the access token + Scenario: Phone number not to be included when it can be deduced from the access token Given the header "Authorization" is set to a valid access token identifying a phone number And the request body property "$.phoneNumber" is set to a valid phone number When the HTTP "POST" request is sent @@ -417,7 +417,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation preparePayment @prepare_payment_C02.04_missing_phone_number Scenario: Phone number not included and cannot be deducted from the access token - Given the header "Authorization" is set to a valid access which does not identify a single phone number + Given the header "Authorization" is set to a valid access token which does not identify a single phone number And the request body property "$.phoneNumber" is not included When the HTTP "POST" request is sent Then the response status code is 422 diff --git a/code/Test_definitions/carrier-billing-refund-createRefund.feature b/code/Test_definitions/carrier-billing-refund-createRefund.feature index 4d1cbb5..1bfe162 100644 --- a/code/Test_definitions/carrier-billing-refund-createRefund.feature +++ b/code/Test_definitions/carrier-billing-refund-createRefund.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.2 - Operation createRefund # * A phone number eligible for payment & refund (no restrictions for it to be used to perform a payment or refund) # * A phone number not-eligible for refund (refund is denied for it due to business conditions) # - # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0-rc.1 Background: Common createRefund setup Given the resource "/carrier-billing-refund/v0.2/refunds" diff --git a/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature b/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature index 1d01be7..14ff8d7 100644 --- a/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature +++ b/code/Test_definitions/carrier-billing-refund-retrievePaymentRemainingAmount.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.2 - Operation retrievePaymentRema # * A phone number eligible for payment & refund # * Several payments refunds performed in different situations (total and partial) # - # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0-rc.1 Background: Common retrievePayment setup Given the resource "/carrier-billing-refund/v0.2/payments/{paymentId}/refunds/remaining-amount" diff --git a/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature b/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature index e75634d..ebe43db 100644 --- a/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature +++ b/code/Test_definitions/carrier-billing-refund-retrieveRefund.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.2 - Operation retrieveRefund # * A phone number eligible for payment & refund # * Several payments and refunds performed in the environment (at least 10 for each of them) # - # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0-rc.1 Background: Common retrieveRefund setup Given the resource "/carrier-billing-refund/v0.2/payments/{paymentId}/refunds/{refundId}" diff --git a/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature b/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature index 4075e5e..90b773c 100644 --- a/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature +++ b/code/Test_definitions/carrier-billing-refund-retrieveRefunds.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing Refund API, v0.2 - Operation retrieveRefunds # * A phone number eligible for payment & refund # * Several payments and refunds performed in the environment (at least 10 for each of them) # - # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in carrier-billing-refund.yaml, version 0.2.0-rc.1 Background: Common retrievePayment setup Given the resource "/carrier-billing-refund/v0.2/payments/{paymentId}/refunds" diff --git a/code/Test_definitions/carrier-billing-retrievePayment.feature b/code/Test_definitions/carrier-billing-retrievePayment.feature index 8b600d3..80c3df7 100644 --- a/code/Test_definitions/carrier-billing-retrievePayment.feature +++ b/code/Test_definitions/carrier-billing-retrievePayment.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation retrievePayment # * A phone number eligible for payment (no restrictions for it to be used to perform a payment) # * Several payments performed in different status in the environment (at least 10) # - # 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.4.0-rc.1 Background: Common retrievePayment setup Given the resource "/carrier-billing/v0.4/payments/{paymentId}" diff --git a/code/Test_definitions/carrier-billing-retrievePayments.feature b/code/Test_definitions/carrier-billing-retrievePayments.feature index ef42252..a455f5b 100644 --- a/code/Test_definitions/carrier-billing-retrievePayments.feature +++ b/code/Test_definitions/carrier-billing-retrievePayments.feature @@ -8,7 +8,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation retrievePayments # * A phone number eligible for payment (no restrictions for it to be used to perform a payment) # * Several payments performed in different status in the environment (at least 10) # - # 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.4.0-rc.1 Background: Common retrievePayment setup Given the resource "/carrier-billing/v0.4/payments" diff --git a/code/Test_definitions/carrier-billing-validatePayment.feature b/code/Test_definitions/carrier-billing-validatePayment.feature index 9658246..4b9b134 100644 --- a/code/Test_definitions/carrier-billing-validatePayment.feature +++ b/code/Test_definitions/carrier-billing-validatePayment.feature @@ -7,7 +7,7 @@ Feature: CAMARA Carrier Billing API, v0.4 - Operation validatePayment # Testing assets: # * N/A (so far) # - # 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.4.0-rc.1 Background: Common validatePayment setup Given the resource "/carrier-billing/v0.4/payments/{paymentId}/validate" diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 5a4ac93..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -Here you can add your documentation and delete this README.MD file diff --git a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md index 9b652ed..85f9b8b 100644 --- a/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-API-Readiness-Checklist.md @@ -5,8 +5,8 @@ Checklist for Carrier Billing v0.4.0-rc.1 in r2.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 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 | | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.2](https://github.com/camaraproject/Commonalities/releases/tag/r2.2) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.1](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.1) | | 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 7505a47..a10ce22 100644 --- a/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md +++ b/documentation/API_documentation/carrier-billing-refund-API-Readiness-Checklist.md @@ -5,8 +5,8 @@ Checklist for Carrier Billing Refund v0.2.0-rc.1 in r2.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 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 | | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.2](https://github.com/camaraproject/Commonalities/releases/tag/r2.2) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.1](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.1) | | 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) |