From febd93fc0b547ea59d53de0f95fe431572603dc6 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 24 Jul 2024 17:01:21 +0200 Subject: [PATCH 1/9] update readme --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6cf4513..62dc905 100644 --- a/README.md +++ b/README.md @@ -18,22 +18,26 @@ Repository to describe, develop, document and test the SimSwap API family * Started: October 2022 * Location: virtually -## Meetings - -* Meetings are held virtually in MS Teams -* Current schedule & meeting links: [Meetings information](documentation/MeetingMinutes/README.MD) - ## 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 available release and version of CAMARA SimSwap API is 0.4.0. This is the first alpha version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. -* Release 0.4.0 of the API is available within the [release-0.4.0 branch](https://github.com/camaraproject/SimSwap/tree/release-0.4.0): -- API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/release-0.4.0/code/API_definitions/sim_swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml) - -## Contributorship and mailing list - -* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . -* A message to all Contributors of this Sub Project can be sent using . +* **The latest pre-release of CAMARA Sim Swap API is 1.0.0-rc.1. This is the release candidate of the first stable version of the API**. It is suitable for implementors. +* The Release Tag is [r1.1](https://github.com/camaraproject/SimSwap/releases/tag/r1.1). + - API definition **with inline documentation**: + - OpenAPI [YAML spec file](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) + +* The previous version 0.4.0 is available within the [release-0.4.0 branch](https://github.com/camaraproject/SimSwap/tree/release-0.4.0) + - API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/release-0.4.0/code/API_definitions/sim_swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml) + +## Contributing + +* Meetings: + * Current schedule, registration, & meeting links are available on the confluence page: [Meetings information](https://wiki.camaraproject.org/display/CAM/NumberVerification) +* Mailing List: + * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . + * A message to all Contributors of this Sub Project can be sent using . From f06e662e7a8b2f4dc602ed76c1c4424cb1103683 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 24 Jul 2024 17:01:43 +0200 Subject: [PATCH 2/9] update changelog --- CHANGELOG.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47fb6c8..1c6d74d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,57 @@ ## Table of Contents +- [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.** + +# r1.1 - rc + +## Release Notes + +This release contains the definition and documentation of +* Sim Swap API 1.0.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +# Sim Swap v1.0.0-rc.1 + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](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/blob/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/blob/r1.1/code/API_definitions/sim_swap.yaml) + +**sim-swap 1.0.0-rc.1 is the first stable version for CAMARA Sim Swap API** + +This version contains significant changes compared to v0.4.0, and it is not backward compatible. + +### 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 +* Add README file to indicate shift to Confluence page by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/101 +* 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 + +### Removed + +* n/a + +## New Contributors + +* @trehman-gsma made their first contribution in https://github.com/camaraproject/SimSwap/pull/62 +* @gregory1g made their first contribution in https://github.com/camaraproject/SimSwap/pull/82 +* @rartych made their first contribution in https://github.com/camaraproject/SimSwap/pull/110 +* @AxelNennker made their first contribution in https://github.com/camaraproject/SimSwap/pull/103 + # v0.4.0 **This is the first alpha release of the CAMARA SimSwap API** From 500ac5f4f2384f0d17e56998ad5e2d267fa5688c Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 24 Jul 2024 17:02:03 +0200 Subject: [PATCH 3/9] update yaml --- code/API_definitions/sim_swap.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/sim_swap.yaml b/code/API_definitions/sim_swap.yaml index bdbc843..f6c30f3 100644 --- a/code/API_definitions/sim_swap.yaml +++ b/code/API_definitions/sim_swap.yaml @@ -52,12 +52,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 1.0.0-rc.1 + x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/SimSwap servers: - - url: "{apiRoot}/sim-swap/v0" + - url: "{apiRoot}/sim-swap/v1rc1" variables: apiRoot: default: http://localhost:9091 From 9a7e66385e76be46de372624fc9332c6d7268475 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 24 Jul 2024 17:21:39 +0200 Subject: [PATCH 4/9] update changelog template --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c6d74d..4c92bf9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.** +The below sections record the changes for each API version in each release as follows: + +* for each first alpha or release-candidate API version, all changes since the release of the previous public API version +* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release +* for a public API version, the consolidated changes since the release of the previous public API version + # r1.1 - rc ## Release Notes From 5982f54a8c5373b252c1f54693ca354e8c2b16a1 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:33:30 +0200 Subject: [PATCH 5/9] Update CHANGELOG.md Add part for sim-swap-subscriptions --- CHANGELOG.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c92bf9..a0c4c69 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,12 +19,13 @@ The below sections record the changes for each API version in each release as fo This release contains the definition and documentation of * Sim Swap API 1.0.0-rc.1 +* Sim Swap Subscriptions v0.1.0alpha1 The API definition(s) are based on * Commonalities v0.4.0 * Identity and Consent Management v0.2.0 -# Sim Swap v1.0.0-rc.1 +## Sim Swap v1.0.0-rc.1 - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim_swap.yaml) @@ -87,6 +88,36 @@ This version contains significant changes compared to v0.4.0, and it is not back * Fixed the security schema as agreed to three-legged only within the release branch * Created CHANGELOG.md and updated README.md within the release branch +## Sim Swap Subscriptions v0.1.0alpha1 + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](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/blob/r1.1/code/API_definitions/sim-swap-subscriptions&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap-subscriptions) + +**sim-swap-subscriptions v0.1.0alpha1 is the first alpha version for CAMARA Sim Swap subscription API** + +## 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 release is suitable for implementors, but it is not recommended to use the API with customers in productive environments + +### Added + +* Add a new API to manage sim swap notification subscription & notification. by @bigludo7 [PR60](https://github.com/camaraproject/SimSwap/pull/60) +* Add subscriptionMaxEvents for maximum number of SIMSwap notifications by @bigludo7 [PR91](https://github.com/camaraproject/SimSwap/pull/91) +* Update SIM Swap notification subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in [PR100](https://github.com/camaraproject/SimSwap/pull/100) +* align subscription model accordingly to the new format defined in Commonalities. This format is aligned with CloudEvents. Fixes examples for phoneNumber by @bigludo7 in [PR111](https://github.com/camaraproject/SimSwap/pull/111) + +### Changed + + +### Removed + +* n/a + + ## New Contributors * @monamok made their first contribution in https://github.com/camaraproject/SimSwap/pull/3 * @DT-DawidWroblewski made their first contribution in https://github.com/camaraproject/SimSwap/pull/8 From 929c40a933cae4438442284b0fc6f89eefd6e7e8 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Tue, 30 Jul 2024 13:10:51 +0200 Subject: [PATCH 6/9] update api readiness checklist --- .../API-Readiness-Checklist_SIM-Swap-1.0.0.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md b/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md index 8061576..267c39f 100644 --- a/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md +++ b/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md @@ -4,18 +4,18 @@ Checklist for SIM Swap 1.0.0 in FALL24 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | | link | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | | | -| 3 | Guidelines from ICM applied | O | M | M | M | | | -| 4 | API versioning convention applied | M | M | M | M | | | -| 5 | API documentation | M | M | M | M | | link | -| 6 | User stories | O | O | O | M | | link | -| 7 | Basic API test cases & documentation | O | M | M | M | | link | -| 8 | Enhanced API test cases & documentation | O | O | O | M | | link | -| 9 | Test result statement | O | O | O | M | | link | -| 10 | API release numbering convention applied | M | M | M | M | | | -| 11 | Change log updated | M | M | M | M | | link | -| 12 | Previous public release was certified | O | O | O | M | | | +| 1 | API definition | M | M | M | M | Y | [link](code/API_definitions/sim_swap.yaml) | +| 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 | Y | [check](documentation/API_documentation/SIM-Swap_check_User_Story.md) [retrieve] | +| 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) | +| 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 | | 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 aef631c2a4faa570b891293715a1aee7b0375e40 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 31 Jul 2024 11:23:52 +0200 Subject: [PATCH 7/9] fix changelog.md format --- CHANGELOG.md | 78 +++++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 38 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a0c4c69..dbabeb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ The below sections record the changes for each API version in each release as fo This release contains the definition and documentation of * Sim Swap API 1.0.0-rc.1 -* Sim Swap Subscriptions v0.1.0alpha1 +* Sim Swap Subscriptions v0.1.0-alpha1 The API definition(s) are based on * Commonalities v0.4.0 @@ -27,15 +27,14 @@ The API definition(s) are based on ## Sim Swap v1.0.0-rc.1 -- API definition **with inline documentation**: - - OpenAPI [YAML spec file](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/blob/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/blob/r1.1/code/API_definitions/sim_swap.yaml) - -**sim-swap 1.0.0-rc.1 is the first stable version for CAMARA Sim Swap API** - +**sim-swap 1.0.0-rc.1 is the first release-candidate version for the v1.0.0 of the Sim Swap API** This version contains significant changes compared to v0.4.0, and it is not backward compatible. +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](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/blob/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/blob/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) @@ -53,6 +52,36 @@ This version contains significant changes compared to v0.4.0, and it is not back * n/a +## Sim Swap Subscriptions v0.1.0-alpha1 + +**sim-swap-subscriptions v0.1.0-alpha1 is the first alpha version for CAMARA Sim Swap subscription API** + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](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/blob/r1.1/code/API_definitions/sim-swap-subscriptions&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap-subscriptions) + +## 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. + +### Added + +* Add a new API to manage sim swap notification subscription & notification. by @bigludo7 [PR60](https://github.com/camaraproject/SimSwap/pull/60) +* Add subscriptionMaxEvents for maximum number of SIMSwap notifications by @bigludo7 [PR91](https://github.com/camaraproject/SimSwap/pull/91) +* Update SIM Swap notification subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in [PR100](https://github.com/camaraproject/SimSwap/pull/100) +* align subscription model accordingly to the new format defined in Commonalities. This format is aligned with CloudEvents. Fixes examples for phoneNumber by @bigludo7 in [PR111](https://github.com/camaraproject/SimSwap/pull/111) + +### Changed + +* n/a + +### Removed + +* n/a + ## New Contributors * @trehman-gsma made their first contribution in https://github.com/camaraproject/SimSwap/pull/62 @@ -60,6 +89,9 @@ This version contains significant changes compared to v0.4.0, and it is not back * @rartych made their first contribution in https://github.com/camaraproject/SimSwap/pull/110 * @AxelNennker made their first contribution in https://github.com/camaraproject/SimSwap/pull/103 + +**Full Changelog**: https://github.com/camaraproject/SimSwap/compare/v0.4.0...r1.1 + # v0.4.0 **This is the first alpha release of the CAMARA SimSwap API** @@ -88,36 +120,6 @@ This version contains significant changes compared to v0.4.0, and it is not back * Fixed the security schema as agreed to three-legged only within the release branch * Created CHANGELOG.md and updated README.md within the release branch -## Sim Swap Subscriptions v0.1.0alpha1 - -- API definition **with inline documentation**: - - OpenAPI [YAML spec file](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/blob/r1.1/code/API_definitions/sim-swap-subscriptions&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap-subscriptions) - -**sim-swap-subscriptions v0.1.0alpha1 is the first alpha version for CAMARA Sim Swap subscription API** - -## 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 release is suitable for implementors, but it is not recommended to use the API with customers in productive environments - -### Added - -* Add a new API to manage sim swap notification subscription & notification. by @bigludo7 [PR60](https://github.com/camaraproject/SimSwap/pull/60) -* Add subscriptionMaxEvents for maximum number of SIMSwap notifications by @bigludo7 [PR91](https://github.com/camaraproject/SimSwap/pull/91) -* Update SIM Swap notification subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in [PR100](https://github.com/camaraproject/SimSwap/pull/100) -* align subscription model accordingly to the new format defined in Commonalities. This format is aligned with CloudEvents. Fixes examples for phoneNumber by @bigludo7 in [PR111](https://github.com/camaraproject/SimSwap/pull/111) - -### Changed - - -### Removed - -* n/a - - ## New Contributors * @monamok made their first contribution in https://github.com/camaraproject/SimSwap/pull/3 * @DT-DawidWroblewski made their first contribution in https://github.com/camaraproject/SimSwap/pull/8 From b0535e8f57c963892a28e0d96ec92d2abe85a29e Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 31 Jul 2024 13:40:26 +0200 Subject: [PATCH 8/9] update file names and readme --- CHANGELOG.md | 6 +-- README.md | 25 +++++++------ ...md => sim-swap-API-Readiness-Checklist.md} | 4 +- ...-subscriptions-API-Readiness-Checklist.md} | 37 +++++++++---------- 4 files changed, 36 insertions(+), 36 deletions(-) rename documentation/API_documentation/{API-Readiness-Checklist_SIM-Swap-1.0.0.md => sim-swap-API-Readiness-Checklist.md} (94%) rename documentation/API_documentation/{API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md => sim-swap-subscriptions-API-Readiness-Checklist.md} (95%) diff --git a/CHANGELOG.md b/CHANGELOG.md index dbabeb3..9a19b4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ The below sections record the changes for each API version in each release as fo This release contains the definition and documentation of * Sim Swap API 1.0.0-rc.1 -* Sim Swap Subscriptions v0.1.0-alpha1 +* Sim Swap Subscriptions v0.1.0-alpha.1 The API definition(s) are based on * Commonalities v0.4.0 @@ -52,9 +52,9 @@ This version contains significant changes compared to v0.4.0, and it is not back * n/a -## Sim Swap Subscriptions v0.1.0-alpha1 +## Sim Swap Subscriptions v0.1.0-alpha.1 -**sim-swap-subscriptions v0.1.0-alpha1 is the first alpha version for CAMARA Sim Swap subscription API** +**sim-swap-subscriptions v0.1.0-alpha.1 is the first alpha version for CAMARA Sim Swap subscription API** - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap-subscriptions.yaml) diff --git a/README.md b/README.md index 62dc905..838594b 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,19 @@ 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 of CAMARA Sim Swap API is 1.0.0-rc.1. This is the release candidate of the first stable version of the API**. It is suitable for implementors. -* The Release Tag is [r1.1](https://github.com/camaraproject/SimSwap/releases/tag/r1.1). - - API definition **with inline documentation**: - - OpenAPI [YAML spec file](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) - -* The previous version 0.4.0 is available within the [release-0.4.0 branch](https://github.com/camaraproject/SimSwap/tree/release-0.4.0) - - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/release-0.4.0/code/API_definitions/sim_swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml) +* 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. + * 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. + * 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) ## Contributing diff --git a/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md similarity index 94% rename from documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md rename to documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index 267c39f..c89b165 100644 --- a/documentation/API_documentation/API-Readiness-Checklist_SIM-Swap-1.0.0.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for SIM Swap 1.0.0 in FALL24 +Checklist for sim-swap 1.0.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -9,7 +9,7 @@ Checklist for SIM Swap 1.0.0 in FALL24 | 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] | +| 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) | | 9 | Test result statement | O | O | O | M | N | | diff --git a/documentation/API_documentation/API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md similarity index 95% rename from documentation/API_documentation/API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md rename to documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md index d4a019e..847a548 100644 --- a/documentation/API_documentation/API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md +++ b/documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md @@ -1,20 +1,19 @@ -# API Readiness Checklist - -Checklist for sim-swap-subscriptions 0.1.0-alpha.1 in FALL24 - - -| 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 | -| 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) | - +# API Readiness Checklist + +Checklist for sim-swap-subscriptions 0.1.0-alpha.1 in r1.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/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 | +| 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) | + | 12 | Previous public release was certified | O | O | O | M | N | NR | \ No newline at end of file From 6b7713c84042ba30adf1a986d891cf1e3f762540 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Thu, 1 Aug 2024 12:25:34 +0200 Subject: [PATCH 9/9] include x-camara-commonalities tag and remove unneded changelog registry --- CHANGELOG.md | 1 - code/API_definitions/sim-swap-subscriptions.yaml | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a19b4f..c035a8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -44,7 +44,6 @@ 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 SIM Swap & SIM Swap notification subscription yaml to make the '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/100 -* Add README file to indicate shift to Confluence page by @bigludo7 in https://github.com/camaraproject/SimSwap/pull/101 * 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 diff --git a/code/API_definitions/sim-swap-subscriptions.yaml b/code/API_definitions/sim-swap-subscriptions.yaml index 3db09bc..e1ca803 100644 --- a/code/API_definitions/sim-swap-subscriptions.yaml +++ b/code/API_definitions/sim-swap-subscriptions.yaml @@ -65,6 +65,7 @@ info: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 0.1.0-alpha.1 + x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA