generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 2
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 #22 from camaraproject/jgarciahospital-patch-5
Create RC version of Device Swap
- Loading branch information
Showing
4 changed files
with
79 additions
and
3 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # 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.1 | ||
|
|
||
| ## 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 | ||
| * 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 | ||
| N/A | ||
| ### 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.1 |
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
18 changes: 18 additions & 0 deletions
18
documentation/SupportingDocuments/device-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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # API Readiness Checklist | ||
|
|
||
| Checklist for device-swap 0.1.0-rc.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/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 | | | ||
| | 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 | | |