From b7eece24a75470fc666d53457b5138c1ef60c0ca Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 8 Oct 2024 18:41:27 +0200 Subject: [PATCH 01/12] Create RC version of device-swap.yaml --- code/API_definitions/device-swap.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/device-swap.yaml b/code/API_definitions/device-swap.yaml index fae4f5d..8488627 100644 --- a/code/API_definitions/device-swap.yaml +++ b/code/API_definitions/device-swap.yaml @@ -60,10 +60,10 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.1.0-rc.1 x-camara-commonalities: 0.4.0 servers: - - url: '{apiRoot}/device-swap/vwip' + - url: '{apiRoot}/device-swap/v0.1rc1' variables: apiRoot: default: http://localhost:9091 From 632d550d3014d538eeb58cb50bb724cb27cdf8f8 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 8 Oct 2024 18:55:02 +0200 Subject: [PATCH 02/12] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c8e4090..c91d2c6 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,16 @@ Repository to describe, develop, document and test the Device Swap API family * Subscribe / Unsubscribe to the mailing list of this Sub Project . * A message to the community of this Sub Project can be sent using . + +## 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 pre-release r1.1 contains the version 0.1.0-rc.1 of the Device Swap API. It is the first release candidate of the v0.1.0. The release tag is [r1.1](https://github.com/camaraproject/DeviceSwap/tree/r1.1). +- 0.1.0-rc.1 Device Swap API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-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 . From eb38858d03a7cbff58623442ddfced2130ac4509 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 8 Oct 2024 19:09:53 +0200 Subject: [PATCH 03/12] Create CHANGELOG.md --- CHANGELOG.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8cab09b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,54 @@ +# Changelog DeviceSwap + +## Table of Contents + +- [r1.1](#r11) + +**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 +## Release Notes + +This release contains the definition and documentation of +* device-swap v0.1.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +## device-swap v0.1.0-rc.1 + +**device-swap v0.1.0-rc.1 is the 1st release candidate of the version 0.1.0** + +- 0.1.0-rc.1 Device Swap API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) + +## What's Changed +### Added +* Update CODEOWNERS by @ShutingQing in https://github.com/camaraproject/DeviceSwap/pull/2 +* Update README.md w/ Meeting info by @wrathwolf in https://github.com/camaraproject/DeviceSwap/pull/7 +* Update CODEOWNERS by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/8 +* Update MAINTAINERS.MD by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/9 +* Update CODEOWNERS - adding Jorge Garcia Hospital by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/12 +* Initial proposal for Device Swap API by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/13 +* Update README.md by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/15 +* Clean error and description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/18 +* Update device-swap description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/17 +* Update APi actions descriptions by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/21 + +### Changed +N/A +### Fixed +N/A +### Removed +N/A + +## New Contributors +* @ShutingQing made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/2 +* @wrathwolf made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/7 +* @bigludo7 made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/8 +* @jgarciahospital made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/13 + +**Full Changelog**: https://github.com/camaraproject/DeviceSwap/commits/r1.1 From f40f9ffaaeb554fcd84acb1dc475b89efd573e23 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 15 Oct 2024 15:51:03 +0200 Subject: [PATCH 04/12] Create device-swap-API-Readiness-Checklist.md --- .../device-swap-API-Readiness-Checklist.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md diff --git a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md new file mode 100644 index 0000000..94adf7e --- /dev/null +++ b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md @@ -0,0 +1,18 @@ +# API Readiness Checklist + +Checklist for device-swap 0.1.0-rc 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/device-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/device-swap.yaml) | +| 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/device-swap_check_User_Story.md) [retrieve](/documentation/API_documentation/device-swap_retrieve_User_Story.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/device-swap-check.feature) [retrieve](/code/Test_definitions/device-swap-retrieve-date.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/device-swap-check.feature) [retrieve](/code/Test_definitions/device-swap-retrieve-date.feature) | +| 9 | Test result statement | O | O | O | M | N | Fall24 EXCEPTION: Test results not available (*) | +| 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 | | From bee7d4a003fa84a5710aec5ad03d3dec54c7e07c Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 15 Oct 2024 15:56:39 +0200 Subject: [PATCH 05/12] Update CHANGELOG.md --- CHANGELOG.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8cab09b..8e3ab1d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,16 +27,10 @@ The API definition(s) are based on ## What's Changed ### Added -* Update CODEOWNERS by @ShutingQing in https://github.com/camaraproject/DeviceSwap/pull/2 -* Update README.md w/ Meeting info by @wrathwolf in https://github.com/camaraproject/DeviceSwap/pull/7 -* Update CODEOWNERS by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/8 -* Update MAINTAINERS.MD by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/9 -* Update CODEOWNERS - adding Jorge Garcia Hospital by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/12 * Initial proposal for Device Swap API by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/13 -* Update README.md by @bigludo7 in https://github.com/camaraproject/DeviceSwap/pull/15 * Clean error and description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/18 -* Update device-swap description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/17 -* Update APi actions descriptions by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/21 +* Updated device-swap description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/17 +* Updated API actions descriptions by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/21 ### Changed N/A @@ -46,8 +40,6 @@ N/A N/A ## New Contributors -* @ShutingQing made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/2 -* @wrathwolf made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/7 * @bigludo7 made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/8 * @jgarciahospital made their first contribution in https://github.com/camaraproject/DeviceSwap/pull/13 From 8556b974ad937738bcf1d9d1c2435dc401d1deb4 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 15 Oct 2024 18:39:39 +0200 Subject: [PATCH 06/12] Update README.md --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c91d2c6..f1bb706 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,15 @@ Repository to describe, develop, document and test the Device Swap API family * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G. * Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: July 2024 -* Location: virtually +* Location: virtually + +## Release Information +* 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 pre-release r1.1 contains the version 0.1.0-rc.1 of the Device Swap API. It is the first release candidate of the v0.1.0. The release tag is [r1.1](https://github.com/camaraproject/DeviceSwap/tree/r1.1). +- 0.1.0-rc.1 Device Swap API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) ## Contributing * Meetings are held virtually @@ -27,15 +35,4 @@ Repository to describe, develop, document and test the Device Swap API family * Subscribe / Unsubscribe to the mailing list of this Sub Project . * A message to the community of this Sub Project can be sent using . -## 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 pre-release r1.1 contains the version 0.1.0-rc.1 of the Device Swap API. It is the first release candidate of the v0.1.0. The release tag is [r1.1](https://github.com/camaraproject/DeviceSwap/tree/r1.1). -- 0.1.0-rc.1 Device Swap API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-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 . From 2119a7149bffc2fa121d2dbcb7d23568c2318a8b Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 15 Oct 2024 18:42:22 +0200 Subject: [PATCH 07/12] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e3ab1d..4ece48b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,6 +31,8 @@ The API definition(s) are based on * Clean error and description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/18 * Updated device-swap description by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/17 * Updated API actions descriptions by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/21 +* Create Gherkin tests for Device Swap API by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/23 +* Include User stories for Device Swap by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/24 ### Changed N/A From a47848576e687814f6ad9be96d378ba2e11dadeb Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:18:28 +0100 Subject: [PATCH 08/12] Update documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../SupportingDocuments/device-swap-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md index 94adf7e..154d164 100644 --- a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md +++ b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for device-swap 0.1.0-rc in r1.1 +Checklist for device-swap 0.1.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 3b6ea9ca86da6b73f4f5bba87fdf245f77ae7101 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:18:48 +0100 Subject: [PATCH 09/12] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ece48b..6fc2cb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ This release contains the definition and documentation of The API definition(s) are based on * Commonalities v0.4.0 -* Identity and Consent Management v0.2.0 +* Identity and Consent Management v0.2.1 ## device-swap v0.1.0-rc.1 From b95a99fd65d52c16fe6f8c9d00dcbb2c7ed500ad Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:19:51 +0100 Subject: [PATCH 10/12] Update README.md Co-authored-by: Herbert Damker --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f1bb706..08d5386 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ Repository to describe, develop, document and test the Device Swap API family * The pre-release r1.1 contains the version 0.1.0-rc.1 of the Device Swap API. It is the first release candidate of the v0.1.0. The release tag is [r1.1](https://github.com/camaraproject/DeviceSwap/tree/r1.1). - 0.1.0-rc.1 Device Swap API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.1/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.1/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.1/code/API_definitions/device-swap.yaml) ## Contributing * Meetings are held virtually From b68f928a92542bee0fd2fb63c282e07431f93753 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:20:12 +0100 Subject: [PATCH 11/12] Update documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../SupportingDocuments/device-swap-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md index 154d164..bbce94d 100644 --- a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md +++ b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md @@ -4,7 +4,7 @@ Checklist for device-swap 0.1.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 | Y | [link](code/API_definitions/device-swap.yaml) | +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/device-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 | | From ae00ee5d7394998e2a50cbe570ee40c9b3aae625 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:20:23 +0100 Subject: [PATCH 12/12] Update documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../SupportingDocuments/device-swap-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md index bbce94d..48a3233 100644 --- a/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md +++ b/documentation/SupportingDocuments/device-swap-API-Readiness-Checklist.md @@ -12,7 +12,7 @@ Checklist for device-swap 0.1.0-rc.1 in r1.1 | 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/device-swap_check_User_Story.md) [retrieve](/documentation/API_documentation/device-swap_retrieve_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/device-swap-check.feature) [retrieve](/code/Test_definitions/device-swap-retrieve-date.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/device-swap-check.feature) [retrieve](/code/Test_definitions/device-swap-retrieve-date.feature) | -| 9 | Test result statement | O | O | O | M | N | Fall24 EXCEPTION: Test results not available (*) | +| 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 | |