From ebdddd618ed8830327ef7a51ee5334bec26a85be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Thu, 10 Aug 2023 12:16:09 +0200 Subject: [PATCH 1/2] README - status and released versions update including Redoc preview link --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3630b19..0dea45d 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,15 @@ Repository to describe, develop, document and test the HomeDevicesQoD API family * Schedule: bi-weekly, Thursday, 4:30pm CET * Meeting link: Microsoft Teams Meeting -## Results and Status -* Sub Project is in progress. +## Status & released versions +* Note: Please be aware that the project will have 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 release and version of Home Devices QoD API is 0.2.0. * Version 0.2.0 of the API is available within the [release-0.2.0](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0) branch: - * API [definition](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/code/API_definitions) - * API [documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/documentation/API_documentation) + * [API definition with inline documentation](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/main/code/API_definitions/home_devices_qod.yaml&nocors) + * OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/code/API_definitions) + * API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/documentation/API_documentation) * For changes see [CHANGELOG.md](https://github.com/camaraproject/HomeDevicesQoD/blob/main/CHANGELOG.md) +* The previous version v0.1.0 of the HomeDevicesQoD API is available within the [release-0.1.0 branch](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.1.0). ## Contributorship and mailing list * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . From cfa1626ec124e37723a96a449eb71ade16c8eb8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Mon, 14 Aug 2023 10:28:34 +0200 Subject: [PATCH 2/2] added Swagger Editor link and CHANGELOG is also updated --- CHANGELOG.md | 14 +++++++++++--- README.md | 6 ++++-- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 866d631..b05ce17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,8 +11,12 @@ # v0.2.0 **This is the first alpha release of Home Devices QoD API**. -- API [definition](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/code/API_definitions) -- API [documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/documentation/API_documentation) + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/release-0.2.0/code/API_definitions/home_devices_qod.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml) +- API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/documentation/API_documentation) ## Please note - This is an alpha version, it should be considered as a draft. @@ -43,7 +47,11 @@ # v0.1.0 - Initial contribution **Initial contribution of the API definition for *QoS-on-demand* (QoD) control applied to devices connected to the user home network**, including initial API documentation. -- API [definition](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.1.0/code/API_definitions) + +- API definition: + - OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/release-0.1.0/code/API_definitions/home_devices_qod.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.1.0/code/API_definitions/home_devices_qod.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.1.0/code/API_definitions/home_devices_qod.yaml) - API [documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.1.0/documentation/API_documentation) ## Please note diff --git a/README.md b/README.md index 0dea45d..f46cd12 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,10 @@ Repository to describe, develop, document and test the HomeDevicesQoD API family * Note: Please be aware that the project will have 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 release and version of Home Devices QoD API is 0.2.0. * Version 0.2.0 of the API is available within the [release-0.2.0](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0) branch: - * [API definition with inline documentation](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/main/code/API_definitions/home_devices_qod.yaml&nocors) - * OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/code/API_definitions) + * API definition **with inline documentation**: + * OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/release-0.2.0/code/API_definitions/home_devices_qod.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml&nocors) + * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml) * API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0/documentation/API_documentation) * For changes see [CHANGELOG.md](https://github.com/camaraproject/HomeDevicesQoD/blob/main/CHANGELOG.md) * The previous version v0.1.0 of the HomeDevicesQoD API is available within the [release-0.1.0 branch](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.1.0).