Skip to content

Latest commit

 

History

History
252 lines (162 loc) · 13.8 KB

CHANGELOG_EXAMPLE.md

File metadata and controls

252 lines (162 loc) · 13.8 KB
Raw

Changelog QualityOnDemand

NOTE: As this example CHANGELOG file is based on the actual CHANGELOG of QualityOnDemand it is important to note that the content of the the v0.10.x releases is here rewritten only for illustration purposes according to the new release process. Within the real sub project the new release process will only be applied to new releases, the existing content of the CHANGELOG file SHALL NOT be rewritten!

Table of contents

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 (pre-)release as follows:

  • for the 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

DISCLAIMER: in this example file, links and other content have been edited from the original to fit the example (hence links may be broken).

r1.5 - patch

Release Notes

This release contains the definition and documentation of

  • quality-on-demand v0.10.1, a patch release of v0.10.0

The API definition(s) are based on

  • Commonalities v0.2.0
  • Identity and Consent Management v0.1.0

quality-on-demand v0.10.1

quality-on-demand v0.10.1 is a patch version. Please read also the notes and changes for v0.10.0 in r1.4

Fixed

  • Updated the documentation to address the lack of statusInfo in SessionInfo temporary by @hdamker in camaraproject/QualityOnDemand#269
    • Note: The parameter statusInfo will be added to SessionInfo within next regular release
  • Fixed maximum duration in session info and improved documentation by @emil-cheung in camaraproject/QualityOnDemand#277
    • Improved the documentation of "Extend the duration of an active session"
    • Improved the datatype "SessionInfo" to remove the maximum limit of duration

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/r1.4...r1.5

r1.4 - public

Release Notes

This release contains the definition and documentation of

  • quality-on-demand v0.10.0

The API definition(s) are based on

  • Commonalities v0.2.0
  • Identity and Consent Management v0.1.0

quality-on-demand v0.10.0

quality-on-demand v0.10.0 is a new initial public version with significant changes compared to the previous initial version v0.9.0 and is not backward compatible.

  • Within notifications the schema EventNotificationhas been replace by CloudEvent in accordance with the updated CAMARA Design Guidelines
  • If within device an IPv6 address is used it must be a single IPv6 address (out of the prefix used by the device)
  • This release includes changes to be compliant with the Design Guidelines and other documents in release v0.2 of CAMARA Commonalities
  • This is another inital (v0.x) release and further releases before the first stable major v1.x release might introduce breaking changes (e.g. API changes to align with Commonalities updates)

Main Changes

  • Aligned event notification with CloudEvent spec which will allow API consumers and implementators to use standard libraries and tools which are available to handle CloudEvents (https://cloudevents.io/)
  • Added a new operation /sessions/{sessionId}/extend which allows to extend the duration of an active session

Added

Changed

Fixed

  • na

Removed

  • na

New Contributors

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/v0.9.0...r1.4

r1.3 - rc

Release Notes

This release contains the definition and documentation of

  • quality-on-demand v0.10.0-rc.2

quality-on-demand v0.10.0-rc.2

quality-on-demand v0.10.0-rc.2 is the second release-candidate version for v0.10.0 of the Quality-On-Demand (QoD) API.

Added

  • Added a new error example for DurationOutOfRangeForQoSProfile by @jlurien in camaraproject/QualityOnDemand#259
  • Added a note to maxDuration parameter within qosProfile schema about the limit of 86400 seconds by @hdamker in camaraproject/QualityOnDemand#256
  • Added statusInfo 'DELETE_REQUESTED' for qosStatus 'UNAVAILABLE' and clarified notification events in documentation by @hdamker in camaraproject/QualityOnDemand#258:
    • notifications will be sent for all changes of QosStatus, even if initiated by the client.
    • what will happen when qosStatus changes from 'AVAILABLE' to 'UNAVAILABLE' due to 'NETWORK_TERMINATED'

Changed

Fixed

  • na

Removed

  • na

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/r1.2...r1.3

r1.2 - rc

Release Notes

This release contains the definition and documentation of

  • quality-on-demand v0.10.0-rc.1

quality-on-demand v0.10.0-rc.1

quality-on-demand v0.10.0-rc.1 is the first release-candidate version for v0.10.0 of the Quality-On-Demand (QoD) API.

  • The version contains significant changes compared to v0.9.0, and it is not backward compatible:
    • Within notifications the schema EventNotificationhas been replace by CloudEvent in accordance with the updated CAMARA Design Guidelines
    • If within device an IPv6 address is used it must be a single IPv6 address (out of the prefix used by the device)
  • This is only the pre-release, it should be considered as a draft of the upcoming release v0.10.0
    • The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.

Main Changes

  • Aligned event notification with CloudEvent spec which will allow API consumers and implementators to use standard libraries and tools which are available to handle CloudEvents (https://cloudevents.io/)
  • Added a new operation /sessions/{sessionId}/extend which allows to extend the duration of an active session

Added

Changed

Fixed

  • NA

Removed

  • NA

New Contributors

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

r1.1 - alpha

Release Notes

This release contains the definition and documentation of

  • quality-on-demand v0.10.0-alpha.1

quality-on-demand v0.10.0-alpha.1

  • This version contains significant changes compared to v0.9.0, and it is not backward compatible

    • Especially a lot of the parameter names changed in line with the agreed glossary within CAMARA Commonalities

  • This is only a pre-release, it should be considered as a draft of the upcoming release v0.10.0

  • The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.

  • API definition with inline documentation

Added

Changed

Fixed

  • NA

Removed

  • NA

New Contributors

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/v0.9.0...r1.1

v0.9.0

NOTE: Original content for older releases has been removed from the example