Skip to content

Commit

Permalink
Update CHANGELOG.md
Browse files Browse the repository at this point in the history
Release notes for r1.2 including:
Editorial changes or some entries from r1.1
Added PR #335 which was missed to be mentioned in r1.1
  • Loading branch information
hdamker committed Aug 23, 2024
1 parent 9aa37df commit 6289a84
Showing 1 changed file with 102 additions and 3 deletions.
105 changes: 102 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Changelog QualityOnDemand

## Table of Contents
- **[r1.1](#r11)**
- [r1.2](#r12)
- [r1.1](#r11)
- [v0.10.1](#v0101)
- [v0.10.0](#v0100)
- [v0.10.0-rc2](#v0100-rc2)
Expand All @@ -12,13 +13,111 @@
- [v0.8.0](#v080)
- [v0.1.0 - Initial contribution](#v010---initial-contribution)

Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts with local implementations.

**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 public release contains the definition and documentation of
* quality-on-demand v0.11.0
* qos-profiles v0.11.0
* qod-provisioning v0.1.0

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

Note: the previous qod v0.10.1 API with endpoints for QoS Sessions and QoS Profiles has been split into two APIs. There are additional breaking changes.

## quality-on-demand v0.11.0

Version 0.11.0 provides the QoS Sessions endpoints from v0.10.1, adds one endpoint /retrieve-sessions, and is aligned with Commonalities 0.4.0 and Identity and Consent Management 0.2.0. **There are breaking changes compared to v0.10.1.**

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

### Added
* Added a new operation `retrieveSessions` to get a list of sessions for a given device by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/325
* Added the `statusInfo` as parameter to `SessionInfo` by @maxl2287 in https://github.com/camaraproject/QualityOnDemand/pull/273
* Added the `x-correlator` header to requests and responses by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/283
* Added security scheme and scopes for each endpoint / method by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/295


### Changed
* Made `+` prefix mandatory for phoneNumber by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/301
* Clarified concepts and properties related to the management of session duration and session extension by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/296
* Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/327
* Aligned with Commonalities' updated subscription-model by using `sink` and `sinkCredentials` by @maxl2287 in https://github.com/camaraproject/QualityOnDemand/pull/335
* Aligned quality-on-demand further with Commonalties 0.4.0 by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/326
* Added documentation about "Handling of device information" within the info description.
* Made device parameter optional within `createSession`
* Aligned `Device` object and `info` object with Commonalities
* Updated schemata for error responses according to Commonalities

### Fixed
* Removed unresolved documentation reference within quality-on-demand.yaml by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/324

### Removed
* Removed unused `messages` object in the `SessionInfo` schema by @sfnuser in https://github.com/camaraproject/QualityOnDemand/pull/312
* Removed `TermsOfService` and `Contact` from `info` objects (they may be added by API Providers documenting their APIs) by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/311
* Removed cucumber directory and its content by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/323

## qos-profiles v0.11.0

qos-profiles 0.11.0 provides the QoS Profiles endpoints from v0.10.1, changed the retrieval operation to allow the get the QoS Profiles available for a given device, and is aligned with Commonalities 0.4.0 and Identity and Consent Management 0.2.0. **There are breaking changes compared to v0.10.1.**

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

### Added
* Added the option to query QoS profiles available on a given device by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/318
* Added `x-correlator` header to requests and responses by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/283
* Added security scheme and scopes for each endpoint / method by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/295

### Changed
* Changed the query for `/qos-profiles` from a GET to a POST to support the query for profiles available on a given device by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/318
* Updated the description of `maxDuration` by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/296
* Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/327
* Aligned qos-profiles further with Commonalties 0.4.0 by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/326
* Added documentation about "Handling of device information" within the info description.
* Updated schemata for error responses according to Commonalities

### Fixed
* n/a

### Removed
* Removed `TermsOfService` and `Contact` from `info` objects (they may be added by API Providers documenting their APIs) by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/311

## qod-provisioning v0.1.0

qod-provisioning v0.1.0 is the first initial release of this new API. It provides the ability to set a QoS profile for a device within an access network which will be applied each time the device connects to the same access network.

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

### Added
* Initial version of QoD Provisioning mode API by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/299

### Changed
* n/a

### Fixed
* n/a

### Removed
* n/a

**Full Changelog**: https://github.com/camaraproject/QualityOnDemand/compare/v0.10.1...r1.2

# r1.1
## Release Notes

This pre-release contains the definition and documentation of
* quality-on-demand v0.11.0-rc.1
* qos-profiles v0.11.0-rc.1
Expand Down

0 comments on commit 6289a84

Please # to comment.