r1.2

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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Added a new operation retrieveSessions to get a list of sessions for a given device by @jlurien in #325
• Added the statusInfo as parameter to SessionInfo by @maxl2287 in #273
• Added the x-correlator header to requests and responses by @jlurien in #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in #295
• Added test definitions for quality-on-demand by @jlurien in #349

Changed

• Made + prefix mandatory for phoneNumber by @jlurien in #301
• Clarified concepts and properties related to the management of session duration and session extension by @jlurien in #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in #327
• Aligned with Commonalities' updated subscription-model by using sink and sinkCredentials by @maxl2287 in #335
• Aligned quality-on-demand further with Commonalties 0.4.0 by @hdamker in #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
• Updated user story for Quality on Demand by @hdamker in #354
• Clarified behavior of extendQosSessionDuration if session is not in state AVAILABLE by @hdamker in #356

Fixed

• Removed unresolved documentation reference within quality-on-demand.yaml by @hdamker in #324

Removed

• Removed unused messages object in the SessionInfo schema by @sfnuser in #312
• Removed TermsOfService and Contact from info objects (they may be added by API Providers documenting their APIs) by @RandyLevensalor in #311
• Removed cucumber directory and its content by @hdamker in #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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Added the option to query QoS profiles available on a given device by @RandyLevensalor in #318 and #348
• Added x-correlator header to requests and responses by @jlurien in #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in #295
• Added test definitions for qos-profiles by @jlurien in #349

Changed

• Changed the query for /qos-profiles from a GET to a POST to support the query for profiles available on a given device and changed the endpoint name to /retrieve-qos-profiles by @RandyLevensalor in #318 and #348
• Updated the description of maxDuration by @jlurien in #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in #327
• Aligned qos-profiles further with Commonalties 0.4.0 by @hdamker in #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 #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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Initial version of QoD Provisioning mode API by @jlurien in #299
• Added test definitions for qod-provisioning by @jlurien in #349

Changed

• n/a

Fixed

• n/a

Removed

• n/a

Full Changelog: v0.10.1...r1.2

r1.1

This pre-release contains the definition and documentation of

• quality-on-demand v0.11.0-rc.1
• qos-profiles v0.11.0-rc.1
• qod-provisioning v0.1.0-rc.1

The API definition(s) are based on

• Commonalities v0.4.0-rc.1
• Identity and Consent Management v0.2.0-rc.2

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-rc.1

quality-on-demand v0.11.0-rc.1 is the first release candidate of the version 0.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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• New operation retrieveSessions to get a list of sessions for a given device by @jlurien in #325
• Added the statusInfo as parameter to SessionInfo by @maxl2287 in #273
• Added x-correlator header to requests and responses by @jlurien in #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in #295

Changed

• Made + prefix mandatory for phoneNumber by @jlurien in #301
• Clarification of concepts and properties related to the management of session duration and session extension by @jlurien in #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in #327
• Aligned quality-on-demand further with Commonalties 0.4.0 by @hdamker in #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 #324

Removed

• Removed unused messages object in the SessionInfo schema by @sfnuser in #312
• Removed TermsOfService and Contact from APIs since they are optional and did not provide useful information by @RandyLevensalor in #311
• Removed cucumber directory and its content by @hdamker in #323

qos-profiles v0.11.0-rc.1

qos-profiles v0.11.0-rc.1 is the first release candidate of the version 0.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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Added the option to query profiles available on a given device by @RandyLevensalor in #318
• Added x-correlator header to requests and responses by @jlurien in #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in #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 #318
• Updated the description of maxDuration by @jlurien in #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in #327
• Aligned qos-profiles further with Commonalties 0.4.0 by @hdamker in #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 APIs since they are optional and did not provide useful information by @RandyLevensalor in #311

qod-provisioning v0.1.0-rc.1

qod-provisioning v0.1.0-rc.1 is the release candidate of the first initial version 0.1.0 of the API

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Initial version of QoD Provision mode API by @jlurien in #299

Changed

• n/a

Fixed

• n/a

Removed

• n/a

Full Changelog: v0.10.1...r1.1

v0.10.1

v0.10.1 is a patch release of v0.10.0 of the Quality-On-Demand (QoD) API. Please read also the notes and changes for v0.10.0 release

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Fixed

• Updated the documentation to address the lack of statusInfo in SessionInfo temporary by @hdamker in #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 #277
  • Improved the documentation of "Extend the duration of an active session"
  • Improved the datatype "SessionInfo" to remove the maximum limit of duration

Further changes within the project

• Added configuration for linting ruleset by @rartych in #270
• Updated the project scope in the README.md by @RandyLevensalor in #255

Full Changelog: v0.10.0...v0.10.1

v0.10.0

This release contains the fourth alpha version of the Quality-On-Demand (QoD) API.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Please note:

• This release contains significant changes compared to v0.9.0, and the QoD API 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 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

• Added new endpoint to extend duration of an active session by @emil-cheung in #216
• Introduced of linting with Megalinter and Swagger Editor Validator by @RandyLevensalor, @maxl2287 and @ravindrapalaskar17 in #206, #207, #212, and #215
• Added global tags element by @rartych in #227
• Added a new error example for DurationOutOfRangeForQoSProfile by @jlurien in #259

Changed

• Align event notification with CloudEvents spec by @jlurien in #224
• Moved "description" out of "allOf" declaration by @maxl2287 in #205
  • Note: this change shouldn't have an impact for API consumers but is relevant for implementations of the API.
• Single IP addresses in Device model specified with standard formats instead of patterns by @jlurien in #237
• Moved "basePath" /qod/v0 to "url"-property and introduced "apiroot" in definition of server @maxl2287 in #252
• Added statusInfo 'DELETE_REQUESTED' for qosStatus 'UNAVAILABLE' and clarified notification events in documentation by @hdamker in #258

Fixed

• NA

Removed

• NA

New Contributors

• @ravindrapalaskar17 made their first contribution in #215
• @rartych made their first contribution in #227

Full Changelog: v0.9.0...v0.10.0

v0.10.0-rc2

This is the second release candidate of v0.10.0 - containing the upcoming fourth alpha version of the Quality-On-Demand (QoD) API

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Changes compared to v0.10.0-rc

• Added a new error example for DurationOutOfRangeForQoSProfile by @jlurien in #259
• Moved "basePath" /qod/v0 to "url"-property and introduced "apiroot" in definition of server @maxl2287 in #252
• Added a note to maxDuration parameter within qosProfile schema about the limit of 86400 seconds by @hdamker in #256
• Added statusInfo 'DELETE_REQUESTED' for qosStatus 'UNAVAILABLE' and clarified notification events in documentation by @hdamker in #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'

Full Changelog: v0.10.0-rc...v0.10.0-rc2

v0.10.0-rc

This is the release candidate of v0.10.0 - containing the upcoming fourth alpha version of the Quality-On-Demand (QoD) API

• API definition with inline documentation:
  • OpenAPI YAML spec file
  • View it on ReDoc
  • View it on Swagger Editor

Please note:

• This release will contain 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

• Added new endpoint to extend duration of an active session by @emil-cheung in #216
• Introduced of linting with Megalinter and Swagger Editor Validator by @RandyLevensalor, @maxl2287 and @ravindrapalaskar17 in #206, #207, #212, and #215
• Added global tags element by @rartych in #227

Changed

• Align event notification with CloudEvents spec by @jlurien in #224
• Moved "description" out of "allOf" declaration by @maxl2287 in #205
  • Note: this change shouldn't have an impact for API consumers but is relevant for implementations of the API.
• Aligned with changes in https://github.com/camaraproject/Template_Lead_Repository on test definitions by @rartych in #233
• Single IP addresses in Device model specified with standard formats instead of patterns by @jlurien in #237

Fixed

• NA

Removed

• NA

New Contributors

• @ravindrapalaskar17 made their first contribution in #215
• @rartych made their first contribution in #227

Full Changelog: v0.9.0...v0.10.0-rc

v0.9.0

This is the third alpha version of the Quality-On-Demand (QoD) API.

• API definition with inline documentation:
  • OpenAPI YAML spec file
  • View it on ReDoc
  • View it on Swagger Editor

Please note:

• This release contains significant breaking changes compared to v0.8.1, 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 an alpha version, it should be considered as a draft.
• There are bug fixes to be expected and incompatible changes in upcoming versions.
• The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

Added

• Introduced qosStatus and corresponding notification event to fix issue #38 by @emil-cheung in #67
• Added basic tests with Cucumber framework using Java and Maven implementation by @mdomale in #134
• Added new methods to get service provider defined QoS Profile by @RandyLevensalor in #138
• Scopes specified and OAuth2 authorizationCode flow added as security mechanism, for operations dealing with QoD sessions by @jlurien in #163
• Added new model EventQosStatus by @jlurien in #167

Changed

• Aligned error format with CAMARA design guidelines by @jlurien in #104
• Renamed properties to new terms agreed in CAMARA Commonalitites by @jlurien in #129
• Updated method for identifying devices by IPv4 address by @eric-murray in #139
• Updated of the notification event related fields based on the CAMARA design guideline by @akoshunyadi in #155
• CAMARA documentation is now embedded within the OAS definition, and not separate by @jlurien in #151

Fixed

• Added error code 501 "Not Implemented" by @dfischer-tech in #124
• Added inheritance between Event and QosStatusChangedEvent and simplified notification payload model by @patrice-conil in #177

Removed

• Removed format lines from Datatypes Ipv4Address and Ipv6Address by @tlohmar in #177
• Removed markdown documentation (now embedded within the OAS definition, see above)

New Contributors

• @jlurien made their first contribution in #104
• @dfischer-tech made their first contribution in #124
• @maheshc01 made their first contribution in #132
• @eric-murray made their first contribution in #139
• @mdomale made their first contribution in #134
• @RandyLevensalor made their first contribution in #138

Full Changelog: v0.8.1...v0.9.0

v0.9.0-rc

This is the release candidate of v0.9.0 - the (third alpha (tbc)) release of the Quality-On-Demand (QoD) API

• API definition with inline documentation

Please note:

• This release contains significant changes compared to v0.8.1, 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 the pre-release, it should be considered as a draft of the upcoming release v0.9.0
• The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.

Added

• Introduced qosStatus and corresponding notification event to fix issue #38 by @emil-cheung in #67
• Added basic tests with Cucumber framework using Java and Maven implementation by @mdomale in #134
• Added new methods to get service provider defined QoS Profile by @RandyLevensalor in #138
• Scopes specified and OAuth2 authorizationCode flow added as security mechanism, for operations dealing with QoD sessions by @jlurien in #163
• Added new model EventQosStatus by @jlurien in #167

Changed

• Aligned error format with CAMARA design guidelines by @jlurien in #104
• Renamed properties to new terms agreed in CAMARA Commonalitites by @jlurien in #129
• Updated method for identifying devices by IPv4 address by @eric-murray in #139
• Updated of the notification event related fields based on the CAMARA design guideline by @akoshunyadi in #155
• CAMARA documentation is now embedded within the OAS definition, and not separate by @jlurien in #151

Fixed

• Added error code 501 "Not Implemented" by @dfischer-tech in #124

Removed

• Removed format lines from Datatypes Ipv4Address and Ipv6Address by @tlohmar in #153
• Removed markdown documentation (now embedded within the OAS definition, see above)

New Contributors

• @jlurien made their first contribution in #104
• @dfischer-tech made their first contribution in #124
• @maheshc01 made their first contribution in #132
• @eric-murray made their first contribution in #139
• @mdomale made their first contribution in #134
• @RandyLevensalor made their first contribution in #138

Full Changelog: v0.8.1...v0.9.0-rc

v0.8.1

This is the second alpha release of the Quality-On-Demand (QoD) API

• API definition
• API documentation

Please note:

• This minor release contains minor fixes of v0.8.0, but is not backward compatible to v0.8.0
• This is an alpha version, it should be considered as a draft.
• There are bug fixes to be expected and incompatible changes in upcoming versions.
• The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

Added

• Added Generic error 500 to remaining procedures by @sfnuser in #86

Changed

• Update from notificationsUri to notificationsUrl by @maxl2287 in #89
• Update and rename QoD_Latency_Bandwidth_User_Story.md by @hdamker in #103

Fixed

• Fixed two typos in qod-api.yaml by @sfnuser in #77

Removed

New Contributors

• @maxl2287 made their first contribution in #89
• @sfnuser made their first contribution in #77

Full Changelog: v0.8.0...v0.8.1

v0.8.0

This is the first alpha version of the Quality-On-Demand (QoD) API.

• Release branch: release-0.8.0
• API definition
• API documentation

Please note:

• This is an alpha version, it should be considered as a draft.
• There are bug fixes to be expected and incompatible changes in upcoming versions.
• The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
• Version numbers 0.2.x to 0.7.x where used in privat versions during the development of the API and are here not used to avoid conflicts with local implementations.
• Provider implementations (PI) will be provided within separate repositories:
  • QualityOnDemand_PI1 by Deutsche Telekom
  • QualityOnDemand_PI2 by Orange

What's Changed

• Contribution of the QoD-API spec v0.8.0 by @akoshunyadi in #54
• Improvements for QoSProfile_Mapping_Table.md by @tlohmar in #62 and @hdamker in #73
• Update qod api documentation to 0.8.0 by @shilpa-padgaonkar in #71
• Editorial updates of documentation QoD_API.md by @hdamker, @kaikreuzer, and @mariobodemann
• Delete code/API_code directory by @hdamker in #93

New Contributors

• @akoshunyadi made their first contribution in #54
• @tlohmar made their first contribution in #62

Full Changelog: v0.1.0...v0.8.0