Skip to content

Commit

Permalink
Merge pull request #165 from fernandopradocabrillo/r1.3
Browse files Browse the repository at this point in the history
Public release r1.3
fernandopradocabrillo authored Oct 29, 2024
2 parents fc25875 + 008e1df commit dd8c4b9
Showing 6 changed files with 62 additions and 16 deletions.
46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@

## Table of contents

- **[r1.3](#r13)**
- **[r1.2](#r12)**
- **[r1.1](#r11)**
- **[v0.4.0](#v040)**
@@ -14,6 +15,51 @@ 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.3

## Release Notes

This release contains the definition and documentation of
* sim-swap 1.0.0
* sim-swap-subscriptions 0.1.1

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.3/code/API_definitions/sim-swap.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap.yaml)

**Main Changes**
* This release only contains and update for the test plan to cover scenarios where no sim swap occurred

### Fixed
* Update test plan by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/159

## Sim Swap Subscriptions v0.1.1

- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap-subscriptions.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/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.3/code/API_definitions/sim-swap-subscriptions.yaml)

**Main Changes**
* Fixed an schema reference that prevented the `createSimSwapSubscription` operation callback request body to render properly

### Fixed
* Add EventSimSwap to Sim Swap Subscriptions by @daniel-dierich in https://github.com/camaraproject/SimSwap/pull/157

## New Contributors
* @daniel-dierich made their first contribution in https://github.com/camaraproject/SimSwap/pull/157

**Full Changelog**: https://github.com/camaraproject/SimSwap/compare/r1.2...r1.3

# r1.2

## Release Notes
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -22,17 +22,17 @@ 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 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-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.2)
* `NEW`: Release r1.3 features following APIs:
* version 1.0.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.3)
* API definitions **with inline documentation**:
* OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap.yaml)
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap.yaml&nocors)
* [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap.yaml)
* version 0.1.1 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.3)
* 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)
* OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap-subscriptions.yaml)
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/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.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
4 changes: 2 additions & 2 deletions code/API_definitions/sim-swap-subscriptions.yaml
Original file line number Diff line number Diff line change
@@ -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.1
x-camara-commonalities: 0.4.0

externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/
servers:
- url: '{apiRoot}/sim-swap-subscriptions/vwip'
- url: '{apiRoot}/sim-swap-subscriptions/v0.1'

variables:
apiRoot:
4 changes: 2 additions & 2 deletions code/Test_definitions/sim-swap-subscriptions.feature
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Feature: CAMARA sim swap subscriptions API, v0.1.0
Feature: CAMARA sim swap subscriptions API, v0.1.1
# Input to be provided by the implementation to the tester
#
# Testing assets:
# * A mobile line identified by its phone number "phoneNumber" associated with a sim card 1
# * Be able to perform a sim swap for this mobile line shifting from sim card 1 to sim card 2
# * a callback url identified as "callbackUrl" allows to receive notification
#
# References to OAS spec schemas refer to schemas specifies in sim-swap-subscriptions.yaml, version v0.1.0
# References to OAS spec schemas refer to schemas specifies in sim-swap-subscriptions.yaml, version v0.1.1

Background: Common subscriptions setup
Given the resource "/sim-swap-subscriptions/v0.1/subscriptions" as BaseURL |
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Readiness Checklist

Checklist for sim-swap 1.0.0 in r1.2
Checklist for sim-swap 1.0.0 in r1.3

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Readiness Checklist

Checklist for sim-swap-subscriptions 0.1.0 in r1.2
Checklist for sim-swap-subscriptions 0.1.1 in r1.3

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|------|

0 comments on commit dd8c4b9

Please sign in to comment.