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.

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

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.

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

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

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

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: r2.2...r3.2