diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d46b9a..e6c1e6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,8 @@ ## Table of contents -- **[r3.2](#r32) Fall25** +- **[r3.3](#r33) Fall25** +- **[r3.2](#r32) ** - **[r3.1](#r31)** - **[r2.2](#r22) Spring25** - **[r2.1](#r21)** @@ -20,6 +21,45 @@ The below sections record the changes for each API version in each release as fo * for subsequent release-candidate(s), only the delta to the previous release-candidate * for a public release, the consolidated changes since the previous public release +# r3.3 + +This maintenance release contains the definition and documentation of +* sim-swap 2.1.0 +* sim-swap-subscriptions 0.3.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## sim-swap 2.1.0 + +**sim-swap v2.1.0 is the public release 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/r3.3/code/API_definitions/sim-swap.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap.yaml) + +**Main changes** +* There are no changes in the spec file since the release r3.2, just an update in the test plan + +### Changed +* Align test plan with commonalities artifact by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/238 + +## Sim Swap Subscriptions v0.3.0 + +**sim-swap-subscriptions v0.3.0 is the public release of the Sim Swap Subscriptions API** + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap-subscriptions.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap-subscriptions.yaml) + +**Main changes** +* There are no changes since the last release r3.2 + +**Full Changelog**: https://github.com/camaraproject/SimSwap/compare/r3.2...r3.3 + # r3.2 This release contains the definition and documentation of @@ -353,7 +393,7 @@ The API definition(s) are based on - 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://camaraproject.github.io/swagger-ui/?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 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 @@ -425,7 +465,7 @@ This version contains significant changes compared to v0.4.0, and it is not back ## Please note: -- There are bug fixes to be expected and incompatible changes in upcoming versions +- 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 @@ -459,12 +499,12 @@ This version contains significant changes compared to v0.4.0, and it is not back - 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 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://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/v0.4.0/code/API_definitions/sim_swap.yaml) ## Please note: -- This is an alpha version, there are bug fixes to be expected and incompatible changes in upcoming versions +- This is an alpha version, 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 - Version numbers before v0.4.0 were used during the development of this version but not released diff --git a/README.md b/README.md index 74f9021..74be53f 100644 --- a/README.md +++ b/README.md @@ -15,39 +15,27 @@ Incubating API Repository to evolve and maintain the definitions and documentati ## Scope -* Service APIs for “SimSwap” (see APIBacklog.md) -* The APIs provide the API consumer with the ability to: +* Service APIs for “SimSwap” (see APIBacklog.md) +* The APIs provide the API consumer with the ability to: * obtain information on any recent SIM pairing change related to the User’s mobile account. -* Describe, develop, document and test the APIs (with 1-2 Telcos) +* Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: October 2022 * Incubating stage since: February 2025 ## 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`: Public release r3.2 features the following APIs: - * version 2.1.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r3.2) +* Public release r3.3 features the following APIs: + * version 2.1.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r3.3) * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r3.2/code/API_definitions/sim-swap.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.2/code/API_definitions/sim-swap.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.2/code/API_definitions/sim-swap.yaml) - * version 0.3.0 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r3.2) + * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap.yaml&nocors) + * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap.yaml) + * version 0.3.0 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r3.3) * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r3.2/code/API_definitions/sim-swap-subscriptions.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.2/code/API_definitions/sim-swap-subscriptions.yaml) - -* Previous Public release r2.2 features the following APIs: - * version 2.0.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r2.2) - * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r2.2/code/API_definitions/sim-swap.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r2.2/code/API_definitions/sim-swap.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r2.2/code/API_definitions/sim-swap.yaml) - * version 0.2.0 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r2.2) - * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r2.2/code/API_definitions/sim-swap-subscriptions.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r2.2/code/API_definitions/sim-swap-subscriptions.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r2.2/code/API_definitions/sim-swap-subscriptions.yaml) + * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap-subscriptions.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap-subscriptions.yaml&nocors) + * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/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 diff --git a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md index f6adc94..3ae8265 100644 --- a/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md +++ b/documentation/API_documentation/sim-swap-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for sim-swap 2.1.0 in r3.2 +Checklist for sim-swap 2.1.0 in r3.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| 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 05432b0..90d9e65 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.3.0 in r3.2 +Checklist for sim-swap-subscriptions 0.3.0 in r3.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|