Skip to content

CHANGELOG.md

Latest commit

 

History

History
1093 lines (761 loc) · 75 KB

CHANGELOG.md

File metadata and controls

1093 lines (761 loc) · 75 KB
Raw

Starting with release automation, new release changelogs are maintained in the CHANGELOG/ directory with per-cycle files.

Changelog QualityOnDemand

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

  • for an alpha release, the delta with respect to the previous release
  • for the first release-candidate, all changes since the last public release
  • for subsequent release-candidate(s), only the delta to the previous release-candidate
  • for a public release, the consolidated changes since the previous public release

r3.2

Release Notes

This public release contains the definition and documentation of

  • quality-on-demand v1.1.0
  • qos-profiles v1.1.0
  • qos-provisioning v0.3.0

The API definition(s) are based on

  • Commonalities v0.6.0 (r3.3)
  • Identity and Consent Management v0.4.0 (r3.3)

quality-on-demand v1.1.0

quality-on-demand v1.1.0 is a minor update of the API, and is backward compatible with v1.0.0.

Added

  • Added HTTP-422 error response when qos profile is not applicable during session creation by @maxl2287 in #433
  • Added error response documentation in info.description by @hdamker in #467
  • Added pattern for sink URI to enforce HTTPS and added 400 INVALID_SINK error code by @hdamker in #491

Changed

  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one by @eric-murray in #453
  • Added gherkin linting and updated test definition files by @maxl2287 in #478
  • Aligned some properties descriptions to latest guidelines in Commonalities r3.3 by @jlurien in #484

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #462
  • Fixed indentation, multiple blank line and trailing space errors in feature files by @eric-murray in #485
  • Fixed test plan step for Authorization Bearer by @jlurien in #482

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

qos-profiles v1.1.0

qos-profiles v1.1.0 is a minor update of the API, and is backward compatible with v1.0.0.

Added

  • Added an optional countryAvailability field to the QoS profile to allow an API provider to indicate in which countries (and networks) the profile is available by @eric-murray in #435
  • Added error response documentation in info.description by @hdamker in #467

Changed

  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding multiple device identifiers in requests and the expected behavior of implementations by @eric-murray in #453
  • Added gherkin linting and updated test definition files by @maxl2287 in #478
  • Aligned some properties descriptions to latest guidelines in Commonalities r3.3 by @jlurien in #484

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #462

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

qos-provisioning v0.3.0

qos-provisioning v0.3.0 is a new initial version of the API with major changes compared to v0.2.0

There are multiple breaking changes compared to v0.2.0 of qod-provisioning, e.g.:

  • The API got renamed to QoS Provisioning (from QoD Provisioning)
  • The resource path is renamed to qos-assignments (from qos-device)
  • Properties, operationIds, schemata etc are aligned with with "qos-assignments", e.g. provisioningId was changed to assignmentId

Added

  • Added error response documentation in info.description by @hdamker in #467
  • Added error 422 QOS_PROVISIONING.QOS_PROFILE_NOT_APPLICABLE by @jlurien in #476
  • Added pattern for sink URI to enforce HTTPS and added 400 INVALID_SINK error code by @hdamker in #491

Changed

  • Refined the terminology throughout the API by @jlurien in #447
    • URL, paths, properties, operationIs and schemata etc are changed, see breaking changes above
  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one by @eric-murray in #453
  • Added gherkin linting and updated test definition files by @maxl2287 in #478
  • Aligned some properties descriptions to latest guidelines in Commonalities r3.3 by @jlurien in #484

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #447
  • Fixed indentation, multiple blank line and trailing space errors in feature files by @eric-murray in #485
  • Fixed test plan step for Authorization Bearer by @jlurien in #482

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/r2.2...r3.2

r3.1

Release Notes

This pre-release contains the definition and documentation of

  • quality-on-demand v1.1.0-rc.2
  • qos-profiles v1.1.0-rc.2
  • qos-provisioning v0.3.0-rc.1

The API definition(s) are based on

  • Commonalities v0.6.0-rc.1 (r3.2)
  • Identity and Consent Management v0.4.0-rc.1 (r3.2)

quality-on-demand v1.1.0-rc.2

quality-on-demand v1.1.0-rc.2 is the first release candidate of the version 1.1.0

quality-on-demand v1.1.0 will be a minor update of the API, and is backward compatible with v1.0.0.

Added

  • Added HTTP-422 error response when qos profile is not applicable during session creation by @maxl2287 in #433
  • Added error response documentation in info.description by @hdamker in #467

Changed

  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one by @eric-murray in #453

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #462

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

qos-profiles v1.1.0-rc.2

qos-profiles v1.1.0-rc.2 is the first release candidate of the version 1.1.0

qos-profiles v1.1.0 will be a minor update of the API, and is backward compatible with v1.0.0.

Added

  • Added an optional countryAvailability field to the QoS profile to allow an API provider to indicate in which countries (and networks) the profile is available by @eric-murray in #435
  • Added error response documentation in info.description by @hdamker in #467

Changed

  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding multiple device identifiers in requests and the expected behavior of implementations by @eric-murray in #453

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #462

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

qos-provisioning v0.3.0-rc.1

qos-provisioning v0.3.0-rc.1 is the release candidate of the version 0.3.0 of the API

There are multiple breaking changes compared to v0.2.0 of qod-provisioning, e.g.:

  • The API got renamed to QoS Provisioning (from QoD Provisioning)
  • The resource path is renamed to qos-assignments (from qos-device)
  • Properties, operationIds, schemata etc are aligned with with "qos-assignments", e.g. provisioningId was changed to assignmentId

Added

  • Added error response documentation in info.description by @hdamker in #467

Changed

  • Refined the terminology throughout the API by @jlurien in #447
    • URL, paths, properties, operationIs and schemata etc are changed, see breaking changes above
  • Adjusted x-correlator pattern as defined in CAMARA Commonalities by @jlurien in #465
  • Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one by @eric-murray in #453

Fixed

  • Resolved mismatch between test and API definition for networkAccessIdentifier and sinkCredential by @jlurien in #447

Removed

  • Removed AUTHENTICATION_REQUIRED error by @eric-murray in #436
  • Removed the IDENTIFIER_MISMATCH error code option from 422 responses and associated test cases by @eric-murray in #453

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/r2.2...r3.1

r2.2

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

Added

  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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 url to uri by @eric-murray in #420

Fixed

  • Clarified sinkCredentials expiration by @jlurien in #396

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.

Added

  • Added new experimental and optional parameters l4sQueueTypeand serviceClass to QoSProfiles by @benhepworth in #384
  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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_IDENTIFIER as 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.

Added

  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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 url to uri by @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-time examples 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: https://github.com/camaraproject/QualityOnDemand/compare/r1.3...r2.2

r2.1

Release Notes

This pre-release contains the definition and documentation of

The API definition(s) are based on

  • Commonalities v0.5.0-rc.1
  • Identity and Consent Management v0.3.0-rc.1

quality-on-demand v1.0.0-rc.1

quality-on-demand v1.0.0-rc.1 is the first release candidate of the version 1.0.0

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

Added

  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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

Fixed

  • Clarified sinkCredentials expiration by @jlurien in #396

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

qos-profiles v1.0.0-rc.1 is the first release candidate of the version 1.0.0

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.

Added

  • Added new experimental and optional parameters l4sQueueTypeand serviceClass to QoSProfiles by @benhepworth in #384
  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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

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_IDENTIFIER as this is not a valid error for either endpoint by @eric-murray in #410

qod-provisioning v0.2.0-rc.1

qod-provisioning v0.2.0-rc.1 is the release candidate 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.

Added

  • Added string validation pattern to x-correlator definitions by @hdamker in #406

Changed

  • Updated info.description text 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

Fixed

  • Clarified sinkCredentials expiration by @jlurien in #396
  • Ensured that date-time examples 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: https://github.com/camaraproject/QualityOnDemand/compare/r1.3...r2.1

r1.3

Release Notes

This patch release contains the definition and documentation of

  • quality-on-demand v0.11.1
  • qos-profiles v0.11.1
  • qod-provisioning v0.1.1

The API definition(s) are based on

  • Commonalities v0.4.0
  • Identity and Consent Management v0.2.1

Note: this release is a patch release, containing some clarifications and updates within the documentation. The API versions are fully backward-compatible to the ones in r1.2. Please see there for the main changes compared to previous 0.10.x release.

quality-on-demand v0.11.1

quality-on-demand 0.11.1 is a patch version of 0.11.0 with documentation updates and clarifications.

Added

  • Added guidance for multi-SIM scenarios in ìnfo.description by @eric-murray in #378

Changed

  • Authorization and authentication section in info.description updated with text from Identity & Consent Management text v0.2.1 by @hdamker in #370
  • Updated the note for the retrieve POST calls by @RandyLevensalor in #372

Fixed

  • Documented that the error response QUALITY_ON_DEMAND.DURATION_OUT_OF_RANGE cannot be returned for /extend and will be removed within next version by @hdamker in #382

Removed

  • n/a

qos-profiles v0.11.1

qos-profiles 0.11.1 is a patch version of 0.11.0 with documentation updates and clarifications.

Added

  • Add QoS Profile User Story by @benhepworth in #367
  • Added guidance for multi-SIM scenarios in ìnfo.description by @eric-murray in #378

Changed

  • Authorization and authentication section in info.description updated with text from Identity & Consent Management text v0.2.1 by @hdamker in #370
  • Updated the note for the retrieve POST calls by @RandyLevensalor in #372

Fixed

  • n/a

Removed

  • n/a

qod-provisioning v0.1.1

qod-provisioning v0.1.1 is a patch version of the first initial release of this new API.

Added

  • Added guidance for multi-SIM scenarios in ìnfo.description by @eric-murray in #378

Changed

  • Authorization and authentication section in info.description updated with text from Identity & Consent Management text v0.2.1 by @hdamker in #370
  • Updated the note for the retrieve POST calls by @RandyLevensalor in #372

Fixed

  • n/a

Removed

  • n/a

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

r1.2

Release Notes

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.

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.

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.

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.10.1...r1.2

r1.1

Release Notes

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.

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.

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

Added

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

Changed

  • n/a

Fixed

  • n/a

Removed

  • n/a

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/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

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

v0.10.0

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

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: https://github.com/camaraproject/QualityOnDemand/compare/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

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.10.0-rc...v0.10.0-rc2

v0.10.0-rc

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

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.9.0...v0.10.0-rc

v0.9.0

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

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)

Full Changelog: https://github.com/camaraproject/QualityOnDemand/compare/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

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.8.1...v0.9.0-rc

v0.8.1

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

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.8.0...v0.8.1

v0.8.0

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

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 were used in private 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:

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: https://github.com/camaraproject/QualityOnDemand/compare/v0.1.0...v0.8.0

v0.1.0 - Initial contribution

Initial contribution of two API definitions for Quality on Demand (stable bandwidth and stable latency), including initial documentation and implementation code.

Please note

  • this "release" is only tagged to document the history of the API, it is not intended to be used by implementors or API customers
  • it was implemented by Deutsche Telekom within lab environment and tested against two NEF implementations
  • going forward the implementation code will not be part of releases of QoD API. Instead it will be provided within separate repositories (QualityOnDemand_PIx).

What's Changed

  • Qod latency api spec 0.1.0 contribution by @shilpa-padgaonkar in #24
  • Qod bandwidth api spec 0.1.0 contribution by @shilpa-padgaonkar in #25
  • Code contribution for release 0.1.0 by @anjagerlach in #28
  • Create QoD-API-Readiness-Checklist.md by @shilpa-padgaonkar in #30

New Contributors

  • @T-sm made their first contribution in #10
  • @anjagerlach made their first contribution in #28

Full Changelog: https://github.com/camaraproject/QualityOnDemand/commits/v0.1.0