From 845e62cae6884869da6b435f278ef820530e9238 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 10 Dec 2024 10:17:54 +0100 Subject: [PATCH 1/8] Update 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 f52a185..869effc 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: 0.1.0-rc.1 + version: 0.1.0 x-camara-commonalities: 0.4.0 servers: - - url: '{apiRoot}/device-swap/v0.1rc1' + - url: '{apiRoot}/device-swap/v0.1' variables: apiRoot: default: http://localhost:9091 From e8d27059599b09eec50435d2329a7f431ffcc55d Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 10 Dec 2024 10:19:53 +0100 Subject: [PATCH 2/8] Update device-swap-API-Readiness-Checklist.md --- .../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 48a3233..feb9158 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.1 in r1.1 +Checklist for device-swap 0.1.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 7b60403b1ced8d6b657846644007347dd45dce73 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 10 Dec 2024 10:23:16 +0100 Subject: [PATCH 3/8] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 08d5386..bb878b1 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,14 @@ Repository to describe, develop, document and test the Device Swap API family ## 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/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) +* The release r1.2 contains the version 0.1.0 of the Device Swap API. It is the release of the v0.1.0. The release tag is [r1.2](https://github.com/camaraproject/DeviceSwap/tree/r1.2). +- 0.1.0 Device Swap API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.2/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.2/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.2/code/API_definitions/device-swap.yaml) +* The latest public release is available here: https://github.com/camaraproject/DeviceSwap/releases/latest +* Other releases of this sub project are available in https://github.com/camaraproject/DeviceSwap/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceSwap/blob/main/CHANGELOG.md) ## Contributing * Meetings are held virtually From 452fa9b1b2f1daa2c06a46006225f9ad05d16551 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Tue, 10 Dec 2024 10:32:20 +0100 Subject: [PATCH 4/8] Update CHANGELOG.md --- CHANGELOG.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fc2cb5..638812c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,52 @@ ## Table of Contents +- **[r1.2](#r12)** - [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.2 +## Release Notes + +This release contains the definition and documentation of +* device-swap v0.1.0 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.1 + +## device-swap v0.1.0 + +**device-swap v0.1.0 is the 1st release of the version 0.1.0** + +- 0.1.0 Device Swap API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.2/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.2/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.2/code/API_definitions/device-swap.yaml) + +## What's Changed +### Added +* Initial proposal for Device Swap API by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/13 +* 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 +* Update device-swap-check.feature by @jgarciahospital in https://github.com/camaraproject/DeviceSwap/pull/29 +### Fixed +N/A +### Removed +N/A + +## New Contributors +* @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.2 + # r1.1 ## Release Notes From 89f57a67722445fcedbd1b71748d2c24d60f9cc5 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:07:35 +0100 Subject: [PATCH 5/8] 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 638812c..a4aa8e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ The API definition(s) are based on ## device-swap v0.1.0 -**device-swap v0.1.0 is the 1st release of the version 0.1.0** +**device-swap v0.1.0 is the public release of the version 0.1.0** - 0.1.0 Device Swap API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.2/code/API_definitions/device-swap.yaml) From 9829b1c4e8afdeee95180b820fcf666759ebb574 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:07:54 +0100 Subject: [PATCH 6/8] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4aa8e4..05237e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,8 +23,8 @@ The API definition(s) are based on - 0.1.0 Device Swap API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.2/code/API_definitions/device-swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/blob/r1.2/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.2/code/API_definitions/device-swap.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.2/code/API_definitions/device-swap.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.2/code/API_definitions/device-swap.yaml) ## What's Changed ### Added From 9a536e29f2fd2da361985ff6e842f337c4084f94 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:08:35 +0100 Subject: [PATCH 7/8] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 05237e3..a1d1a57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -64,8 +64,8 @@ The API definition(s) are based on - 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) ## What's Changed ### Added From 98e3f66eaafb60d9788a2e0927615c37d76044c5 Mon Sep 17 00:00:00 2001 From: Jorge Garcia Hospital <129095857+jgarciahospital@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:09:00 +0100 Subject: [PATCH 8/8] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bb878b1..817f0bb 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Repository to describe, develop, document and test the Device Swap API family ## 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 release r1.2 contains the version 0.1.0 of the Device Swap API. It is the release of the v0.1.0. The release tag is [r1.2](https://github.com/camaraproject/DeviceSwap/tree/r1.2). +* The release r1.2 contains the version 0.1.0 of the Device Swap API. The release tag is [r1.2](https://github.com/camaraproject/DeviceSwap/tree/r1.2). - 0.1.0 Device Swap API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r1.2/code/API_definitions/device-swap.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r1.2/code/API_definitions/device-swap.yaml&nocors)