Release Notes
This public release contains the definition and documentation of
The API definition(s) are based on
- Commonalities v0.5.0
- Identity and Consent Management v0.3.0
quality-on-demand v1.0.0
quality-on-demand v1.0.0 is the public release of the first stable version 1.0.0 of the API
Version 1.0.0 provides the QoS Sessions endpoints from v0.11.1, and is aligned with Commonalities 0.5 and Identity and Consent Management 0.3.
There are breaking changes compared to v0.11.1.: the API use has been simplified for API consumers using a three-legged access token to invoke the API. In these cases the optional device parameter MUST NOT be provided, as the subject will be uniquely identified from the access token. In this context also some error response codes have been renamed or replaced to comply with Commonalities 0.5. With the change to a stable API version also the version of the event type has been changed to v1 in org.camaraproject.quality-on-demand.v1.qos-status-changed
- API definition with inline documentation:
Added
Changed
- Updated
info.descriptiontext on device object handling by @eric-murray in #391 - Updated error responses and test cases to comply with Commonalities 0.5.0 by @eric-murray in #391
- Utilized device test scenarios as defined in artifacts of Commonalities by @jlurien in #400
- Updated documentation, aligned with CAMARA glossary and ICM 0.3.0 by @hdamker in #409 and #407
- Updated 429 error responses to align with Commonalities 0.5.0-rc.1 changes by @hdamker in #412
- Changed the of the event type from v0 to v1 in org.camaraproject.quality-on-demand.v1.qos-status-changed by @hdamker in #407
- Note: this change has been done to align with the stable version of the API itself, the actual event structure has not been changed
- Changed notification sink format from
urltouriby @eric-murray in #420
Fixed
Removed
- Removed the 403 INVALID_TOKEN_CONTEXT error from the OAS definitions by @eric-murray in #391
- Removed all 5XX errors as these no longer require to be explicitly documented by @eric-murray in #391
qos-profiles v1.0.0
qos-profiles v1.0.0 is the public release of the first stable version 1.0.0 of the API
qos-profiles 1.0.0 provides the QoS Profiles endpoints from v0.11.1, and is aligned with Commonalities 0.5 and Identity and Consent Management 0.3.
There are breaking changes compared to v0.11.1.: the API use has been simplified for API consumers using a three-legged access token to invoke the API. In these cases the optional device parameter MUST NOT be provided, as the subject will be uniquely identified from the access token. In this context also some error response codes have been renamed or replaced to comply with Commonalities 0.5.
- API definition with inline documentation:
Added
- Added new experimental and optional parameters
l4sQueueTypeandserviceClassto QoSProfiles by @benhepworth in #384 - Added string validation pattern to x-correlator definitions by @hdamker in #406
Changed
- Updated
info.descriptiontext on device object handling by @eric-murray in #391 and #410, the latter indicating that providing both a 3-legged token and explicit device identifier is an error, but providing neither is not - Updated error responses and test cases to comply with Commonalities 0.5.0 by @eric-murray in #391
- Utilized device test scenarios as defined in artifacts of Commonalities by @jlurien in #400
- Updated the description intro by @RandyLevensalor in #395
- Updated documentation, aligned with CAMARA glossary and ICM 0.3.0 by @hdamker in #409 and #407
- Updated 429 error responses to align with Commonalities 0.5.0-rc.1 changes by @hdamker in #412
- Removed some telco specific terms and updated some language within the descriptions by @RandyLevensalor in #424
Fixed
- N/A
Removed
- Removed the 403 INVALID_TOKEN_CONTEXT error from the OAS definitions by @eric-murray in #391
- Removed all 5XX errors as these no longer require to be explicitly documented by @eric-murray in #391
- Removed error
422 MISSING_IDENTIFIERas this is not a valid error for either endpoint by @eric-murray in #410
qod-provisioning v0.2.0
qod-provisioning v0.2.0 is the public release of the version 0.2.0 of the API
There are breaking changes compared to v0.1.1.: the API use has been simplified for API consumers using a three-legged access token to invoke the API. In these cases the optional device parameter MUST NOT be provided, as the subject will be uniquely identified from the access token. In this context also some error response codes have been renamed or replaced to comply with Commonalities 0.5.
- API definition with inline documentation:
Added
Changed
- Updated
info.descriptiontext on device object handling by @eric-murray in #391 - Updated error responses and test cases to comply with Commonalities 0.5.0 by @eric-murray in #391
- Utilized device test scenarios as defined in artifacts of Commonalities by @jlurien in #400
- Updated documentation, aligned with CAMARA glossary and ICM 0.3.0 by @hdamker in #409 #407
- Updated 429 error responses to align with Commonalities 0.5.0-rc.1 changes by @hdamker in #412
- Changed notification sink format from
urltouriby @eric-murray in #420 - OperationIds renamed, some descriptions changed, and .feature files renamed accordingly by @jlurien in #423 (further changes are to be expected in a later version, see #415)
Fixed
- Clarified sinkCredentials expiration by @jlurien in #396
- Ensured that
date-timeexamples are enclosed by quotation marks by @eric-murray in #391
Removed
- Removed the 403 INVALID_TOKEN_CONTEXT error from the OAS definitions by @eric-murray in #391
- Removed all 5XX errors as these no longer require to be explicitly documented by @eric-murray in #391
Full Changelog: r1.3...r2.2
