diff --git a/CHANGELOG.md b/CHANGELOG.md index cf6029c..f0c93d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r2.2](#r22) - [r2.1](#r21) - [r1.3](#r13) - [r1.2](#r12) @@ -16,6 +17,47 @@ 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 +# r2.2 + +## Release Notes + +This public release contains the definition and documentation of +* number-recycling v0.2.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## number-recycling v0.2.0 + +**number-recycling v0.2.0 is the second public release of the Number-Recycling API.** + +- number-recycling v0.2.0 API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml) + +### Added +* Add text on undocumented errors to OAS definition in https://github.com/camaraproject/NumberRecycling/pull/56 +* Add a missing summary for operation POST /check to YAML file in https://github.com/camaraproject/NumberRecycling/pull/64 + +### Changed +* Update x-correlator pattern in https://github.com/camaraproject/NumberRecycling/pull/59 +* Update test plan and align with Commonalities guidelines in https://github.com/camaraproject/NumberRecycling/pull/60 +* Update versions in API and test definitions back to wip in https://github.com/camaraproject/NumberRecycling/pull/63 +* Update a description in error schema in https://github.com/camaraproject/NumberRecycling/pull/71 + +### Fixed +* Fix feature files for compliance with centralised linting rules in https://github.com/camaraproject/NumberRecycling/pull/67 + +### Removed +* Remove AUTHENTICATION_REQUIRED error code in https://github.com/camaraproject/NumberRecycling/pull/47 + +## New Contributors +* N/A + +**Full Changelog**: https://github.com/camaraproject/NumberRecycling/compare/r1.3...r2.2 + # r2.1 ## Release Notes diff --git a/README.md b/README.md index 59740be..5ea971a 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,10 @@ Sandbox API Repository to describe, develop, document, and test the NumberRecycl * 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 latest public release of CAMARA Number Recycling is [r1.3](https://github.com/camaraproject/NumberRecycling/releases/tag/r1.3)**. -
This is a public release. Generated as a patch release of [r1.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r1.2) +* **The latest public release of CAMARA Number Recycling is [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2)**. - Contains the following API definitions **with inline documentation**: - - [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r1.3/code/API_definitions/number-recycling.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.3/code/API_definitions/number-recycling.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.3/code/API_definitions/number-recycling.yaml&nocors) -* **NEW**: Pre-release [r2.1](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.1) with number-recycling v0.2.0-rc.1 is available. + - [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) +* **NEW**: Public release [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2) with number-recycling v0.2.0 is available. ## Contributing * Meetings of KnowYourCustomer Sub Project are held virtually diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index a3042f8..cbd844b 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -68,7 +68,7 @@ info: Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: wip + version: 0.2.0 x-camara-commonalities: 0.6 license: @@ -78,7 +78,7 @@ externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/NumberRecycling servers: - - url: '{apiRoot}/number-recycling/vwip' + - url: '{apiRoot}/number-recycling/v0.2' variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/number-recycling.feature b/code/Test_definitions/number-recycling.feature index 433e952..eb077f3 100644 --- a/code/Test_definitions/number-recycling.feature +++ b/code/Test_definitions/number-recycling.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Number Recycling API, vwip - Operation checkNumberRecycling +Feature: CAMARA Number Recycling API, v0.2.0 - Operation checkNumberRecycling # Environment variables: # * api_root: API root of the server URL # @@ -10,7 +10,7 @@ Feature: CAMARA Number Recycling API, vwip - Operation checkNumberRecycling Background: Common checkNumberRecycling setup Given an environment at "apiRoot" - And the resource "/number-recycling/vwip/check" + And the resource "/number-recycling/v0.2/check" 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/number-recycling-API-Readiness-Checklist.md b/documentation/API_documentation/number-recycling-API-Readiness-Checklist.md index 41dd9be..02d7bcb 100644 --- a/documentation/API_documentation/number-recycling-API-Readiness-Checklist.md +++ b/documentation/API_documentation/number-recycling-API-Readiness-Checklist.md @@ -1,19 +1,19 @@ # API Readiness Checklist -Checklist for number-recycling v0.2.0-rc.1 in r2.1 +Checklist for number-recycling v0.2.0 in r2.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/number-recycling.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) | +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/number-recycling.yaml) | +| 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 | contained in API definition | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/Number_Recycling_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | M | [link](/code/Test_definitions/number-recycling.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/number-recycling.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | r2.1 | +| 10 | API release numbering convention applied | M | M | M | M | Y | r2.2 | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/90571216/KnowYourCustomer+Number+Recycling+API+description) | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/0AFmBQ) |