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