From 60db1b41d3d38649502d6a04db3c13306664cbe9 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:12:37 +0200 Subject: [PATCH 01/31] Update sim-swap.yaml Change version to v1.0.0 --- code/API_definitions/sim-swap.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/sim-swap.yaml b/code/API_definitions/sim-swap.yaml index 827fbb7..481c12d 100644 --- a/code/API_definitions/sim-swap.yaml +++ b/code/API_definitions/sim-swap.yaml @@ -73,13 +73,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 1.0.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/SimSwap servers: - - url: "{apiRoot}/sim-swap/v1rc1" + - url: "{apiRoot}/sim-swap/v1" variables: apiRoot: default: http://localhost:9091 From 86617b922c6727720e8a30a501c1644213128504 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:13:09 +0200 Subject: [PATCH 02/31] Update sim-swap-subscriptions.yaml --- code/API_definitions/sim-swap-subscriptions.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/sim-swap-subscriptions.yaml b/code/API_definitions/sim-swap-subscriptions.yaml index 3922935..d8d4bd6 100644 --- a/code/API_definitions/sim-swap-subscriptions.yaml +++ b/code/API_definitions/sim-swap-subscriptions.yaml @@ -61,14 +61,14 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.1.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: '{apiRoot}/sim-swap-subscriptions/v0.1alpha1' + - url: '{apiRoot}/sim-swap-subscriptions/v0' variables: apiRoot: default: http://localhost:9091 From 784a17eec7eb44e2ac5f53f37cd62ceda4e10a91 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:17:26 +0200 Subject: [PATCH 03/31] Update sim-swap-API-Readiness-Checklist.md --- .../API_documentation/sim-swap-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index 330a0cd..97ad287 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -15,7 +15,7 @@ Checklist for sim-swap 1.0.0 in r1.2 | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | | +| 12 | Previous public release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) | To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. From c83b001f63886b1fe7278690dfc0711a3028b395 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:21:56 +0200 Subject: [PATCH 04/31] Update sim-swap-API-Readiness-Checklist.md Fix links for test definition --- .../API_documentation/sim-swap-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index 97ad287..0df5bd5 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -10,8 +10,8 @@ Checklist for sim-swap 1.0.0 in r1.2 | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | | 6 | User stories | O | O | O | M | Y | [check](documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve](documentation/API_documentation/SIM-Swap_retrieve_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [PR#70](https://github.com/camaraproject/SimSwap/pull/70) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [PR#70](https://github.com/camaraproject/SimSwap/pull/70) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_Definitions/retrieveSimSwapDate.feature) [link](/code/Test_Definitions/checkSimSwap.feature)| +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/retrieveSimSwapDate.feature) [link](/code/Test_Definitions/checkSimSwap.feature) | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From 06c98e668421de0c8a579c2331c9d11c5a2ceb71 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:28:04 +0200 Subject: [PATCH 05/31] Update sim-swap-API-Readiness-Checklist.md Fix links for test definition --- .../API_documentation/sim-swap-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index 0df5bd5..036afd2 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -9,9 +9,9 @@ Checklist for sim-swap 1.0.0 in r1.2 | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | -| 6 | User stories | O | O | O | M | Y | [check](documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve](documentation/API_documentation/SIM-Swap_retrieve_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_Definitions/retrieveSimSwapDate.feature) [link](/code/Test_Definitions/checkSimSwap.feature)| -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/retrieveSimSwapDate.feature) [link](/code/Test_Definitions/checkSimSwap.feature) | +| 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve](/documentation/API_documentation/SIM-Swap_retrieve_User_Story.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/checkSimSwap.feature) [retrieve](/code/Test_definitions/retrieveSimSwapDate.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/checkSimSwap.feature) [retrieve](/code/Test_definitions/retrieveSimSwapDate.feature) | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From 72e5c1a16b7278612aa015927389c37e5c05b704 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:37:03 +0200 Subject: [PATCH 06/31] Update sim-swap-subscriptions-API-Readiness-Checklist.md Prepare API Checklist for sim swap subscription --- ...p-subscriptions-API-Readiness-Checklist.md | 26 ++++++++++++------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index 847a548..4a40281 100644 --- a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for sim-swap-subscriptions 0.1.0-alpha.1 in r1.1 +Checklist for sim-swap-subscriptions 0.1.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -8,12 +8,20 @@ Checklist for sim-swap-subscriptions 0.1.0-alpha.1 in r1.1 | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Y | | 3 | Guidelines from ICM applied | O | M | M | M | Y | Y | | 4 | API versioning convention applied | M | M | M | M | Y | Y | -| 5 | API documentation | M | M | M | M | Y | contained in API definition | -| 6 | User stories | O | O | O | M | Y | Not Relevant (NR) | -| 7 | Basic API test cases & documentation | O | M | M | M | N | NR | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | NR | -| 9 | Test result statement | O | O | O | M | N | NR | -| 10 | API release numbering convention applied | M | M | M | M | Y | Y | -| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) | +| 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | +| 6 | User stories | O | O | O | M | N | N | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/sim-swap-subscriptions.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | N | +| 9 | Test result statement | O | O | O | M | N | N | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | N | -| 12 | Previous public release was certified | O | O | O | M | N | NR | \ No newline at end of file +To fill the checklist: +- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. +- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release. +- in the Comments column, provide the link to the asset once available, and any other relevant comments. + +Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. + +The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ) From 297feef17542ff059c999958a2be3e4cb056f5b1 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:44:23 +0200 Subject: [PATCH 07/31] Update README.md Update readme for r1.2 --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 838594b..1814de0 100644 --- a/README.md +++ b/README.md @@ -21,19 +21,21 @@ Repository to describe, develop, document and test the SimSwap API family ## Status and released versions * Note: 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 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 pre-release is [r1.1](https://github.com/camaraproject/SimSwap/releases/tag/r1.1). It contains: - * **sim-swap v1.0.0-rc.1** - * **This is the release candidate of the first stable version of the Sim Swap API**. It is suitable for implementors. +* `NEW`: Release r1.2 with following APIs: + * **sim-swap v1.0.0** * API definitions (with inline documentation): - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim_swap.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml&nocors) - * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml) - * sim-swap-swap-subscriptions v0.1.0-alpha.1 - * This is the first alpha version for CAMARA Sim Swap subscription API. It should considered as a draft. + * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim_swap.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml&nocors) + * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml) + * **sim-swap-swap-subscriptions v0.1.0** * API definitions (with inline documentation): - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap-subscriptions.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap-subscriptions.yaml&nocors) - * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap-subscriptions.yaml) + * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) + * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) + + * The latest public release is available here: https://github.com/camaraproject/SimSwap/releases/latest + * Other releases of this sub project are available in https://github.com/camaraproject/SimSwap/releases + * For changes see [CHANGELOG.md](https://github.com/camaraproject/Simswap/blob/main/CHANGELOG.md) ## Contributing From 8178ac3f69df7cbef1d9043ad0d6a8476469067e Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:50:02 +0200 Subject: [PATCH 08/31] Update README.md Making aligned with other readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1814de0..d87c311 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,13 @@ Repository to describe, develop, document and test the SimSwap API family * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. * `NEW`: Release r1.2 with following APIs: - * **sim-swap v1.0.0** - * API definitions (with inline documentation): + * version 1.0.0 of the **API sim-swap** is available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) + * API definitions **with inline documentation**): * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim_swap.yaml) * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml&nocors) * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml) - * **sim-swap-swap-subscriptions v0.1.0** - * API definitions (with inline documentation): + * version 0.1.0 of the **API sim-swap-swap-subscriptions** is available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) + * API definitions **with inline documentation**: * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) From dee92c8ed8cb6f4c3d2881df3e96e4f450a23927 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 15:10:39 +0200 Subject: [PATCH 09/31] Update CHANGELOG.md update changelog for r1.2 --- CHANGELOG.md | 100 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 93 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd6e292..2f8a307 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,10 @@ # Changelog CAMARA SimSwap -## Table of Contents +## Table of contents -- [r1.1](#r11) -- [v0.4.0](#v040) +- **[r1.2](#r12)** +- **[r1.1](#r11)** +- **[v0.4.0](#v040)** **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.** @@ -13,7 +14,94 @@ 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.1 - rc +# r1.2 + +## Release Notes + +This release contains the definition and documentation of +* sim-swap 1.0.0 +* sim-swap-subscriptions 0.1.0 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +## sim-swap 1.0.0 + +**sim-swap 1.0.0 is the public release for v1.0.0 of the Sim Swap API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swaps.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap.yaml) + +**Main Changes** + +* API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release +* Additional documentation & test cases added. + + +### Added + +* User Story in documentation/API_documentation directory by @jgarciahospital [PR125](https://github.com/camaraproject/SimSwap/pull/125) +* Test Definition in Test_Definitions directory by @fernandopradocabrillo [PR70](https://github.com/camaraproject/SimSwap/pull/70) +* add API-Name aka wild-card scope by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 + +### Changed + +* Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) +* Update SIM Swap subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 +* phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 +* Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 + +### Fixed + +* N/A + +### Removed + +* N/A + +## New Contributors +* N/A + +## Sim Swap Subscriptions v0.1.0 + +**sim-swap-subscriptions v0.1.0 is the first initial version for CAMARA Sim Swap subscription API** + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) + +**Main Changes** + +* Initial contribution of the API definition for sim swap subscription allowing API consumer to subscribe to get notified when a sim swap occurs on a device. +* API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release +* Test cases added. + + +### Added + +* Initial yaml contribution by @bigludo7 [PR60](https://github.com/camaraproject/SimSwap/pull/60) +* Test Definition in Test_Definitions directory by @bigludo7 [PR147](https://github.com/camaraproject/SimSwap/pull/147) + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## New Contributors +* N/A + +# r1.1 ## Release Notes @@ -36,14 +124,13 @@ This version contains significant changes compared to v0.4.0, and it is not back - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml) ### Added - * User Story in documentation/API_documentation directory by @jgarciahospital [PR125](https://github.com/camaraproject/SimSwap/pull/125) * Test Definition in Test_Definitions directory by @fernandopradocabrillo [PR70](https://github.com/camaraproject/SimSwap/pull/70) * add API-Name aka wild-card scope by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 ### Changed * Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) -* Update SIM Swap & SIM Swap notification subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 +* Update yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 @@ -62,7 +149,6 @@ This version contains significant changes compared to v0.4.0, and it is not back ## Please note: -- This is an **alpha version**, it should be considered as a **draft** - There are bug fixes to be expected and incompatible changes in upcoming versions - The API version is suitable for test implementations and has the purpose to collect feedback for its further development. It should not be used with customers in productive environments. From d296e0f1698d4f696950ca3c904bb55dd5c43a95 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 15:15:50 +0200 Subject: [PATCH 10/31] Update CHANGELOG.md update changelog --- CHANGELOG.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f8a307..8be5766 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,30 +36,25 @@ The API definition(s) are based on - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap.yaml) **Main Changes** - * API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release * Additional documentation & test cases added. ### Added - * User Story in documentation/API_documentation directory by @jgarciahospital [PR125](https://github.com/camaraproject/SimSwap/pull/125) * Test Definition in Test_Definitions directory by @fernandopradocabrillo [PR70](https://github.com/camaraproject/SimSwap/pull/70) * add API-Name aka wild-card scope by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 ### Changed - * Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) -* Update SIM Swap subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 +* Update SIM Swap yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 ### Fixed - * N/A ### Removed - * N/A ## New Contributors @@ -75,32 +70,28 @@ The API definition(s) are based on - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) **Main Changes** - * Initial contribution of the API definition for sim swap subscription allowing API consumer to subscribe to get notified when a sim swap occurs on a device. * API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release * Test cases added. - ### Added - * Initial yaml contribution by @bigludo7 [PR60](https://github.com/camaraproject/SimSwap/pull/60) * Test Definition in Test_Definitions directory by @bigludo7 [PR147](https://github.com/camaraproject/SimSwap/pull/147) ### Changed - * N/A ### Fixed - * N/A ### Removed - * N/A ## New Contributors * N/A +**Full Changelog**: https://github.com/camaraproject/SimSwap/compare/v0.4.0...r1.2 + # r1.1 ## Release Notes From a924182677a1eafa4d23a81ec3f7161dacb55208 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 15:21:27 +0200 Subject: [PATCH 11/31] Update README.md fix duplicate swap --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d87c311..45240c0 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,13 @@ Repository to describe, develop, document and test the SimSwap API family ## Status and released versions * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* `NEW`: Release r1.2 with following APIs: - * version 1.0.0 of the **API sim-swap** is available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) +* `NEW`: Release r1.2 features following APIs: + * version 1.0.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) * API definitions **with inline documentation**): * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim_swap.yaml) * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml&nocors) * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim_swap.yaml) - * version 0.1.0 of the **API sim-swap-swap-subscriptions** is available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) + * version 0.1.0 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.2) * API definitions **with inline documentation**: * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) From 4f33ccd1baaed1123eadee1e373db84535100dbd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:54:02 +0200 Subject: [PATCH 12/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8be5766..5bbe8b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -43,7 +43,7 @@ The API definition(s) are based on ### Added * User Story in documentation/API_documentation directory by @jgarciahospital [PR125](https://github.com/camaraproject/SimSwap/pull/125) * Test Definition in Test_Definitions directory by @fernandopradocabrillo [PR70](https://github.com/camaraproject/SimSwap/pull/70) -* add API-Name aka wild-card scope by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 +* Added the API name `sim-swap` as a scope to request access to both available endpoints by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 ### Changed * Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) From ea61978ab17f8765b8a99a0eb5585ac87342c4d6 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:54:17 +0200 Subject: [PATCH 13/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bbe8b6..b0829e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,7 +46,7 @@ The API definition(s) are based on * Added the API name `sim-swap` as a scope to request access to both available endpoints by @AxelNennker in https://github.com/camaraproject/SimSwap/pull/103 ### Changed -* Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) +* Made response properties `latestSimChange` and `swapped` required since they will always be returned by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/97 * Update SIM Swap yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 From f1b1bfe2ecf37ccb479c0bea237f7ab95d59fd00 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:54:24 +0200 Subject: [PATCH 14/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b0829e7..f5b870f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,7 +47,7 @@ The API definition(s) are based on ### Changed * Made response properties `latestSimChange` and `swapped` required since they will always be returned by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/97 -* Update SIM Swap yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 +* Updated pattern to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 From d72e9b67bca585a9608a75d42d2093052c452cb7 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:54:42 +0200 Subject: [PATCH 15/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f5b870f..f590b65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -48,7 +48,7 @@ The API definition(s) are based on ### Changed * Made response properties `latestSimChange` and `swapped` required since they will always be returned by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/97 * Updated pattern to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 -* phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 +* Replaced "MSISDN" with "phone number" in descriptions to follow Commonalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 ### Fixed From 07b54bef24f8ec62342ba1506fe91767f76d9d41 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:54:51 +0200 Subject: [PATCH 16/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f590b65..f611771 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -49,7 +49,7 @@ The API definition(s) are based on * Made response properties `latestSimChange` and `swapped` required since they will always be returned by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/97 * Updated pattern to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * Replaced "MSISDN" with "phone number" in descriptions to follow Commonalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 -* Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 +* Removed unused errors and align with Commonalities error definitions by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 ### Fixed * N/A From e6d019710ef3eb382e31718aebde658583adaed5 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:55:00 +0200 Subject: [PATCH 17/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f611771..11c4e7d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -121,7 +121,7 @@ This version contains significant changes compared to v0.4.0, and it is not back ### Changed * Make response properties "latestSimChange" and "swapped" required since they will always be returned [Issue 96](https://github.com/camaraproject/SimSwap/issues/96) -* Update yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 +* Updated pattern to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 * phone number instead of MSISDN to follow communalities guidelines by @gregory1g in https://github.com/camaraproject/SimSwap/pull/116 * Remove unused errors and align with commonalities errors by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/126 From b376efa4e138506fbd399431f6ee71a4682c3755 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:55:19 +0200 Subject: [PATCH 18/31] Update code/API_definitions/sim-swap-subscriptions.yaml Co-authored-by: Herbert Damker --- code/API_definitions/sim-swap-subscriptions.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/sim-swap-subscriptions.yaml b/code/API_definitions/sim-swap-subscriptions.yaml index d8d4bd6..7c0d685 100644 --- a/code/API_definitions/sim-swap-subscriptions.yaml +++ b/code/API_definitions/sim-swap-subscriptions.yaml @@ -68,7 +68,8 @@ externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: '{apiRoot}/sim-swap-subscriptions/v0' + - url: '{apiRoot}/sim-swap-subscriptions/v0.1' + variables: apiRoot: default: http://localhost:9091 From 3286af2d02a80b87a5c1a39b7ed2052961706037 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:55:34 +0200 Subject: [PATCH 19/31] Update documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../sim-swap-subscriptions-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index 4a40281..d252a7e 100644 --- a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -5,9 +5,9 @@ Checklist for sim-swap-subscriptions 0.1.0 in r1.2 | 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/sim-swap-subscriptions.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Y | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | Y | -| 4 | API versioning convention applied | M | M | M | M | Y | Y | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | | 6 | User stories | O | O | O | M | N | N | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/sim-swap-subscriptions.feature) | From 30958fdc24cd0d6769542c0f22584fe1fd6d7de9 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:55:59 +0200 Subject: [PATCH 20/31] Update documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../sim-swap-subscriptions-API-Readiness-Checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index d252a7e..f54b553 100644 --- a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -9,13 +9,13 @@ Checklist for sim-swap-subscriptions 0.1.0 in r1.2 | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | -| 6 | User stories | O | O | O | M | N | N | +| 6 | User stories | O | O | O | M | N | | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/sim-swap-subscriptions.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | N | -| 9 | Test result statement | O | O | O | M | N | N | +| 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 | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | N | +| 12 | Previous public release was certified | O | O | O | M | N | | To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. From f14dc8529d3e61723326faaa1aa597c3ff2afe7d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:56:39 +0200 Subject: [PATCH 21/31] Update documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../sim-swap-subscriptions-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index f54b553..2c665c1 100644 --- a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -3,7 +3,7 @@ Checklist for sim-swap-subscriptions 0.1.0 in r1.2 | 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/sim-swap-subscriptions.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | From 1b6584669a7a0959b810ebb7f072afdb5ace674a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:56:56 +0200 Subject: [PATCH 22/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 11c4e7d..7e5008b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -62,7 +62,7 @@ The API definition(s) are based on ## Sim Swap Subscriptions v0.1.0 -**sim-swap-subscriptions v0.1.0 is the first initial version for CAMARA Sim Swap subscription API** +**sim-swap-subscriptions v0.1.0 is the first initial version for the CAMARA Sim Swap Subscriptions API** - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) From 306237fba0c4ed2aa1e159cae4594ca208758203 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:57:12 +0200 Subject: [PATCH 23/31] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e5008b..29b2c4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -70,7 +70,7 @@ The API definition(s) are based on - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.2/code/API_definitions/sim-swap-subscriptions.yaml) **Main Changes** -* Initial contribution of the API definition for sim swap subscription allowing API consumer to subscribe to get notified when a sim swap occurs on a device. +* Initial contribution of the API definition for Sim Swap Subscriptions allowing API consumers to subscribe to get notified when a sim swap occurs on a device. * API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release * Test cases added. From b2e975c7e5b866cde3fff32dcf429e2e21fc55b6 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 14:22:41 +0200 Subject: [PATCH 24/31] Update and rename checkSimSwap.feature to check-sim-swap.feature Make linting happy --- .../{checkSimSwap.feature => check-sim-swap.feature} | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) rename code/Test_definitions/{checkSimSwap.feature => check-sim-swap.feature} (98%) diff --git a/code/Test_definitions/checkSimSwap.feature b/code/Test_definitions/check-sim-swap.feature similarity index 98% rename from code/Test_definitions/checkSimSwap.feature rename to code/Test_definitions/check-sim-swap.feature index 41db871..810b56d 100644 --- a/code/Test_definitions/checkSimSwap.feature +++ b/code/Test_definitions/check-sim-swap.feature @@ -5,8 +5,8 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap # Testing assets: # # References to OAS spec schemas refer to schemas specifies in sim_swap.yaml, version 1.0.0 - - check if SIM swap has been performed during a past period + # + # check if SIM swap has been performed during a past period Background: Common checkSimSwap setup Given the resource "sim-swap/v0/check" @@ -15,7 +15,6 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap And the header "x-correlator" is set to a UUID value And the request body is set by default to a request body compliant with the schema - # This first scenario serves as a minimum, not testing any specific verificationResult @check_sim_swap_1_generic_success_scenario Scenario: Common validations for any sucess scenario @@ -29,7 +28,7 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap # Scenarios testing specific situations @check_sim_swap_2_valid_sim_swap_no_max_age - Scenario: Check that the response shows that the SIM has been swapped + Scenario: Check that the response shows that the SIM has been swapped using default value for maxAge Given the request header "Authorization" is set to a valid access token from which a phone number connected to the Operator's network can be deducted And the SIM for this phone number has been swapped in the last 240 hours When the request "checkSimSwap" is sent @@ -37,7 +36,7 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap And the value of response property "$.swapped" == true @check_sim_swap_3_valid_sim_swap_max_age - Scenario Outline: Check that the response shows that the SIM has been swapped + Scenario Outline: Check that the response shows that the SIM has been swapped - maxAge is provided in the request Given the request header "Authorization" is set to a valid access token from which a phone number connected to the Operator's network can be deducted And the SIM for this phone number has been swapped in the last "" And the "maxAge" request body property is set to a value equal or greater than "" within the allowed range @@ -64,7 +63,7 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap Scenario: Check that the response shows that the SIM has not been swapped when the last swap was before the maxAge field Given the request header "Authorization" is set to a valid access token from which a phone number connected to the Operator's network can be deducted And the request body property "maxAge" is set to the number of hours since the last SIM swap minus 1 - And the last swap for this phone number's SIM was more than "maxAge" hours ago + And the last swap for this phone number's SIM was more than "maxAge" hours ago When the request "checkSimSwap" is sent Then the response status code is 200 And the value of response property "$.swapped" == false From 47c3c6893069ef344dcf74fc177d2e2c99ff6308 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 14:23:45 +0200 Subject: [PATCH 25/31] Update and rename retrieveSimSwapDate.feature to retrieve-sim-swap-date.feature --- ...eveSimSwapDate.feature => retrieve-sim-swap-date.feature} | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) rename code/Test_definitions/{retrieveSimSwapDate.feature => retrieve-sim-swap-date.feature} (98%) diff --git a/code/Test_definitions/retrieveSimSwapDate.feature b/code/Test_definitions/retrieve-sim-swap-date.feature similarity index 98% rename from code/Test_definitions/retrieveSimSwapDate.feature rename to code/Test_definitions/retrieve-sim-swap-date.feature index a70daee..0f3457a 100644 --- a/code/Test_definitions/retrieveSimSwapDate.feature +++ b/code/Test_definitions/retrieve-sim-swap-date.feature @@ -5,8 +5,8 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation retrieveSimSwapDate # Testing assets: # # References to OAS spec schemas refer to schemas specifies in sim_swap.yaml, version 1.0.0 - - Get timestamp of last MSISDN <-> IMSI pairing change for the provided phone number. + # + # Get timestamp of last MSISDN <-> IMSI pairing change for the provided phone number. Background: Common retrieveSimSwapDate setup Given the resource "sim-swap/v0/retrieve-date" @@ -25,7 +25,6 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation retrieveSimSwapDate And the response header "x-correlator" has same value as the request header "x-correlator" And the response body complies with the OAS schema at "/components/schemas/SimSwapInfo" - # Scenarios testing specific situations @retrieve_sim_swap_date_2_valid_sim_swap From 6f90939b4d729c1a6023c81ae916002f945b28da Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:38:57 +0200 Subject: [PATCH 26/31] Update sim-swap-API-Readiness-Checklist.md update name of the feature files --- .../API_documentation/sim-swap-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index 036afd2..cfdf6b9 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -10,8 +10,8 @@ Checklist for sim-swap 1.0.0 in r1.2 | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | | 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve](/documentation/API_documentation/SIM-Swap_retrieve_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/checkSimSwap.feature) [retrieve](/code/Test_definitions/retrieveSimSwapDate.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/checkSimSwap.feature) [retrieve](/code/Test_definitions/retrieveSimSwapDate.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/check-sim-swap.feature) [retrieve](/code/Test_definitions/retrieve-sim-swap-date.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/check-sim-swap.feature) [retrieve](/code/Test_definitions/retrieve-sim-swap-date.feature) | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From 61e299bac2299357321a764f8b51e3a322fa0efa Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:31:19 +0200 Subject: [PATCH 27/31] Update documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md Co-authored-by: Jose Luis Urien --- .../sim-swap-subscriptions-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index 2c665c1..38dc28c 100644 --- a/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -8,7 +8,7 @@ Checklist for sim-swap-subscriptions 0.1.0 in r1.2 | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | +| 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) | | 6 | User stories | O | O | O | M | N | | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/sim-swap-subscriptions.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | From 73c453538549c55f214c1b0fc204a2522aa5af57 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:32:19 +0200 Subject: [PATCH 28/31] Update check-sim-swap.feature Change sim-swap/v0/check to sim-swap/v1/check --- code/Test_definitions/check-sim-swap.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/check-sim-swap.feature b/code/Test_definitions/check-sim-swap.feature index 810b56d..399b6d1 100644 --- a/code/Test_definitions/check-sim-swap.feature +++ b/code/Test_definitions/check-sim-swap.feature @@ -9,7 +9,7 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation checkSimSwap # check if SIM swap has been performed during a past period Background: Common checkSimSwap setup - Given the resource "sim-swap/v0/check" + Given the resource "sim-swap/v1/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" is set to a UUID value From 456890fe0bb82c6d49503afc6bce886202dbf92b Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:32:54 +0200 Subject: [PATCH 29/31] Update retrieve-sim-swap-date.feature Change sim-swap/v0/retrieve-date to sim-swap/v1/retrieve-date --- code/Test_definitions/retrieve-sim-swap-date.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/retrieve-sim-swap-date.feature b/code/Test_definitions/retrieve-sim-swap-date.feature index 0f3457a..7fd57c5 100644 --- a/code/Test_definitions/retrieve-sim-swap-date.feature +++ b/code/Test_definitions/retrieve-sim-swap-date.feature @@ -9,7 +9,7 @@ Feature: CAMARA SIM Swap API, 1.0.0 - Operation retrieveSimSwapDate # Get timestamp of last MSISDN <-> IMSI pairing change for the provided phone number. Background: Common retrieveSimSwapDate setup - Given the resource "sim-swap/v0/retrieve-date" + Given the resource "sim-swap/v1/retrieve-date" 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" is set to a UUID value From 313aa4d0dfdd249fe731904775b98fe605e8915c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:33:38 +0200 Subject: [PATCH 30/31] Update sim-swap-subscriptions.feature Chenge /sim-swap-subscriptions/v0/subscriptions to /sim-swap-subscriptions/v0.1/subscriptions --- code/Test_definitions/sim-swap-subscriptions.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/sim-swap-subscriptions.feature b/code/Test_definitions/sim-swap-subscriptions.feature index 55ee0d9..e9ba206 100644 --- a/code/Test_definitions/sim-swap-subscriptions.feature +++ b/code/Test_definitions/sim-swap-subscriptions.feature @@ -9,7 +9,7 @@ Feature: CAMARA sim swap subscriptions API, v0.1.0 # References to OAS spec schemas refer to schemas specifies in sim-swap-subscriptions.yaml, version v0.1.0 Background: Common subscriptions setup - Given the resource "/sim-swap-subscriptions/v0/subscriptions" as BaseURL | + Given the resource "/sim-swap-subscriptions/v0.1/subscriptions" as BaseURL | 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" is set to a UUID value From a37dd705482193ca344d16b62e9ece991c2036bd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 5 Sep 2024 18:40:41 +0200 Subject: [PATCH 31/31] Update sim-swap-API-Readiness-Checklist.md Taking care of the Test result statement accordingly to https://github.com/camaraproject/ReleaseManagement/issues/89 --- .../API_documentation/sim-swap-API-Readiness-Checklist.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index cfdf6b9..b42ca3e 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -12,11 +12,13 @@ Checklist for sim-swap 1.0.0 in r1.2 | 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve](/documentation/API_documentation/SIM-Swap_retrieve_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/check-sim-swap.feature) [retrieve](/code/Test_definitions/retrieve-sim-swap-date.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/check-sim-swap.feature) [retrieve](/code/Test_definitions/retrieve-sim-swap-date.feature) | -| 9 | Test result statement | O | O | O | M | N | | +| 9 | Test result statement | O | O | O | M | N | Fall24 EXCEPTION: Test results not available (*) | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) | +(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release. + To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. - in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.