Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Public Release for Fall24 meta-release #70

Merged
merged 5 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Table of Contents

- **[r1.2](#r12)**
- **[r1.1](#r11)**
- [v0.3.0](#v030)
- [v0.2.0](#v020)
Expand All @@ -15,6 +16,53 @@ The below sections record the changes for each API version in each release as fo
* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
* for a public API version, the consolidated changes since the release of the previous public API version

# r1.2

## Release Notes

This release contains the definition and documentation of
* home-devices-qod v0.4.0

The API definition(s) are based on
* Commonalities v0.4.0
* Identity and Consent Management v0.2.0

## home-devices-qod v0.4.0

**home-devices-qod v0.4.0 is the public release for v0.4.0 of the HomeDevicesQoD API.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.2/code/API_definitions/home-devices-qod.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.2/code/API_definitions/home-devices-qod.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/r1.2/code/API_definitions/home-devices-qod.yaml)

**Main Changes**

* API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release. No new features were added.

### Added

* N/A

### Changed

* API spec update for Fall24 meta-release by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/64
* Update testing definitions in .feature file for Fall24 meta-release by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/65
* Update filenames to kebab-case format by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/70

### Fixed

* N/A

### Removed

* N/A

## New Contributors
* N/A

**Full Changelog**: https://github.com/camaraproject/HomeDevicesQoD/compare/v0.3.0...r1.2

# r1.1

## Release Notes
Expand Down Expand Up @@ -45,11 +93,8 @@ The API definition(s) are based on

### Changed

* Update and review codeowners and maintainers md file by @hdamker in https://github.com/camaraproject/HomeDevicesQoD/pull/62
* Update README.md according to camaraproject/Template_Lead_Repository by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/67
* API spec update for Fall24 meta-release by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/64
* Update testing definitions in .feature file for Fall24 meta-release by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/65
* Update with the new API-Readiness-Checklist.md for Fall24 meta-release by @jpengar in https://github.com/camaraproject/HomeDevicesQoD/pull/66

### Fixed

Expand All @@ -60,7 +105,7 @@ The API definition(s) are based on
* N/A

## New Contributors
* @hdamker made their first contribution in https://github.com/camaraproject/HomeDevicesQoD/pull/62
* N/A

**Full Changelog**: https://github.com/camaraproject/HomeDevicesQoD/compare/v0.3.0...r1.1

Expand Down
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,13 @@ Repository to describe, develop, document and test the HomeDevicesQoD API family

## Release Information
* 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**.
* `NEW`: Pre-release r1.1 of API version `0.4.0-rc.1` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/r1.1)
* `NEW`: Release r1.2 of API version `0.4.0` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/r1.2)
* API definition **with inline documentation**:
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.1/code/API_definitions/home_devices_qod.yaml&nocors)
* [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.1/code/API_definitions/home_devices_qod.yaml)
* OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/r1.1/code/API_definitions/home_devices_qod.yaml)
* API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/r1.1/documentation/API_documentation)
* **The previous release `v0.3.0` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/v0.3.0)**
* API definition **with inline documentation**:
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/v0.3.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/v0.3.0/code/API_definitions/home_devices_qod.yaml)
* OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/v0.3.0/code/API_definitions/home_devices_qod.yaml)
* API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/v0.3.0/documentation/API_documentation)
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.2/code/API_definitions/home-devices-qod.yaml&nocors)
* [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/r1.2/code/API_definitions/home-devices-qod.yaml)
* OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/r1.2/code/API_definitions/home-devices-qod.yaml)
* API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/r1.2/documentation/API_documentation)
* The latest public release is available here: https://github.com/camaraproject/HomeDevicesQoD/releases/latest
* Other releases of this sub project are available in https://github.com/camaraproject/HomeDevicesQoD/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/HomeDevicesQoD/blob/main/CHANGELOG.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.4.0-rc.1
version: 0.4.0
x-camara-commonalities: 0.4.0
servers:
- url: "{apiRoot}/home-devices-qod/v0.4rc1"
- url: "{apiRoot}/home-devices-qod/v0.4"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# API Readiness Checklist

Checklist for home-devices-qod 0.4.0-rc.1 in r1.1
Checklist for home-devices-qod 0.4.0 in r1.2

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
| 1 | API definition | M | M | M | M | Y | [home_devices_qod.yaml](/code/API_definitions/home_devices_qod.yaml) |
| 1 | API definition | M | M | M | M | Y | [home-devices-qod.yaml](/code/API_definitions/home-devices-qod.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 | Embedded in [API definition](/code/API_definitions/home_devices_qod.yaml) |
| 6 | User stories | O | O | O | M | Y | [home_devices_qod_user_stories.md](/documentation/API_documentation/home_devices_qod_user_stories.md) |
| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](/code/API_definitions/home-devices-qod.yaml) |
| 6 | User stories | O | O | O | M | Y | [home-devices-qod-User-Stories.md](/documentation/API_documentation/home-devices-qod-User-Stories.md) |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
| 9 | Test result statement | O | O | O | M | N | |
Expand Down