r1.2

[hdamker]

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 List sessions endpoint for quality-on-demand #325
• Added the statusInfo as parameter to SessionInfo by @maxl2287 in feat: add the statusInfo as parameter to the SessionInfo  #273
• Added the x-correlator header to requests and responses by @jlurien in Add X-Correlator and other fixes #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in Add required security scheme and scopes #295
• Added test definitions for quality-on-demand by @jlurien in QoD Test definitions #349

Changed

• Made + prefix mandatory for phoneNumber by @jlurien in Make + prefix mandatory for phoneNumber #301
• Clarified concepts and properties related to the management of session duration and session extension by @jlurien in Consolidation of changes related to session duration #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in Update ICM AuthZ/AuthN Template to Release 0.2.0 wording #327
• Aligned with Commonalities' updated subscription-model by using sink and sinkCredentials by @maxl2287 in Align on Commonalities' subscription-model by using sink and sinkCredentials #335
• Aligned quality-on-demand further with Commonalties 0.4.0 by @hdamker in Align quality-on-demand with Commonalties regarding optional device object and error messages #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 Update QoD_User_Story.md #354
• Clarified behavior of extendQosSessionDuration if session is not in state AVAILABLE by @hdamker in Add new error schema to extendDuration: SessionStateInConflict409 with QUALITY_ON_DEMAND.SESSION_EXTENSION_NOT_ALLOWED  #356

Fixed

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

Removed

• Removed unused messages object in the SessionInfo schema by @sfnuser in Remove unused messages object in SessionInfo schema #312
• Removed TermsOfService and Contact from info objects (they may be added by API Providers documenting their APIs) by @RandyLevensalor in Remove ToS and contact info #311
• Removed cucumber directory and its content by @hdamker in Removed cucumber directory and its content #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 Add query to qos-profiles to query profiles available on a given device #318 and Updating names qos-profile of endpoints #348
• Added x-correlator header to requests and responses by @jlurien in Add X-Correlator and other fixes #283
• Added security scheme and scopes for each endpoint / method by @eric-murray in Add required security scheme and scopes #295
• Added test definitions for qos-profiles by @jlurien in QoD Test definitions #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 Add query to qos-profiles to query profiles available on a given device #318 and Updating names qos-profile of endpoints #348
• Updated the description of maxDuration by @jlurien in Consolidation of changes related to session duration #296
• Updated Authorization and Authentication text to ICM release 0.2.0 wording by @eric-murray in Update ICM AuthZ/AuthN Template to Release 0.2.0 wording #327
• Aligned qos-profiles further with Commonalties 0.4.0 by @hdamker in Align quality-on-demand with Commonalties regarding optional device object and error messages #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 Remove ToS and contact info #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 New API QOD Provisioning #299
• Added test definitions for qod-provisioning by @jlurien in QoD Test definitions #349

Changed

• n/a

Fixed

• n/a

Removed

• n/a

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

---

This discussion was created from the release r1.2.