diff --git a/CHANGELOG.md b/CHANGELOG.md index 47fb6c8..c035a8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,95 @@ ## 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.** + +The below sections record the changes for each API version in each release as follows: + +* for each first alpha or release-candidate API version, all changes since the release of the previous public API version +* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release +* for a public API version, the consolidated changes since the release of the previous public API version + +# r1.1 - rc + +## Release Notes + +This release contains the definition and documentation of +* Sim Swap API 1.0.0-rc.1 +* Sim Swap Subscriptions v0.1.0-alpha.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 + +**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) +* 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 +* 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 + +## Sim Swap Subscriptions v0.1.0-alpha.1 + +**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) + - [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 +* @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 + + +**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** diff --git a/README.md b/README.md index 6cf4513..838594b 100644 --- a/README.md +++ b/README.md @@ -18,22 +18,27 @@ 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 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 + +* 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 . diff --git a/code/API_definitions/sim-swap-subscriptions.yaml b/code/API_definitions/sim-swap-subscriptions.yaml index 7f54396..2f30e73 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 diff --git a/code/API_definitions/sim_swap.yaml b/code/API_definitions/sim_swap.yaml index d81aae7..847defd 100644 --- a/code/API_definitions/sim_swap.yaml +++ b/code/API_definitions/sim_swap.yaml @@ -78,12 +78,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 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 63% 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 8061576..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,21 +1,21 @@ # 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 | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 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](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 | | +| 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. 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