-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #127 from fernandopradocabrillo/release-1.0.0-rc.1
Release of API version 1.0.0-rc.1
- Loading branch information
Showing
6 changed files
with
143 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 <https://lists.camaraproject.org/g/sp-ssw>. | ||
| * A message to all Contributors of this Sub Project can be sent using <[email protected]>. | ||
| * 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 <https://lists.camaraproject.org/g/sp-ssw>. | ||
| * A message to all Contributors of this Sub Project can be sent using <[email protected]>. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 13 additions & 13 deletions
26
...API-Readiness-Checklist_SIM-Swap-1.0.0.md → ...ation/sim-swap-API-Readiness-Checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 18 additions & 19 deletions
37
...st_sim-swap-subscriptions-0.1.0.alpha1.md → ...-subscriptions-API-Readiness-Checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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<br>public | stable<br> 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<br>public | stable<br> 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 | |