Merge pull request #31 from camaraproject/jgarciahospital-patch-7

Prepare release r1.2

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 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)
+  - [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
+* 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
 
@@ -22,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

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. 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 <!-- for new API families request a meeting link from the LF admin team or replace the information with the existing meeting information (of the API family) -->

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

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<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|