Skip to content

Commit

Permalink
Release candidate #1 pre-release PR for Fall24 meta-release (#68)
Browse files Browse the repository at this point in the history
* Release candidate #1 pre-release PR for Fall24 meta-release

* Changes to address Tanja's comments

* API spec update per ICM r0.2.0-rc.2 info.description template last changes
  • Loading branch information
jpengar authored Aug 5, 2024
1 parent b5a8587 commit 4dc18d5
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 9 deletions.
61 changes: 58 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,68 @@

## Table of Contents


- [v0.1.0 - Initial contribution](#v010---initial-contribution)
- [v0.2.0](#v020)
- **[r1.1](#r11)**
- [v0.3.0](#v030)
- [v0.2.0](#v020)
- [v0.1.0 - Initial contribution](#v010---initial-contribution)

**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.**

The below sections record the changes for each API version in each release as follows:

* for each first alpha or release-candidate API version, all changes since the release of the previous public API version
* 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.1

## Release Notes

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

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

## home-devices-qod v0.4.0-rc.1

**home-devices-qod v0.4.0-rc.1 is the first release-candidate version 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.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)

**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

* 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

* N/A

### Removed

* N/A

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

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

# v0.3.0

**This is the second alpha release of Home Devices QoD API**.
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +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**.
* **The latest public release `v0.3.0` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/v0.3.0)**
* `NEW`: Pre-release r1.1 of API version `0.4.0-rc.1` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/r1.1)
* 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)
Expand Down
7 changes: 2 additions & 5 deletions code/API_definitions/home_devices_qod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ info:
# Authorization and authentication
[Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
Expand All @@ -56,9 +56,6 @@ info:
# Further info and support
(FAQs will be added in a later version of the documentation)
termsOfService: http://swagger.io/terms/
contact:
email: [email protected]
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down Expand Up @@ -362,4 +359,4 @@ tags:
description: QoD control operations for home devices
externalDocs:
description: Project documentation at CAMARA
url: https://github.com/camaraproject/
url: https://github.com/camaraproject/HomeDevicesQoD

0 comments on commit 4dc18d5

Please sign in to comment.