QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family

Scope

• Service APIs for “Quality on Demand” (see APIBacklog.md)
• It provides the customer with the ability to:
  • set quality for a mobile connection (e.g. required latency, jitter, bit rate)
  • get notification if network cannot fulfill
  • NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
• Describe, develop, document and test the APIs (with 1-2 Telcos)
• Started: October 2021
• Location: virtually

Meetings

• Meetings are held virtually
• Schedule: bi-weekly, Friday, 2 PM CET/CEST (13:00 UTC, 12:00 UTC during European DST). For date/time of next meeting see previous meeting minutes.
• Meeting link: Microsoft Teams Meeting

Status and released versions

• Note: 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 a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release.

• The Release Candidate for v0.10.0 of the Quality-On-Demand is available. The upcoming release will contain the fourth alpha version of the QoD API
  Until the release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

• The release candidate for v0.10.0 is available in the release-0.10.0-rc branch

  • API definition with inline documentation:
    • OpenAPI YAML spec file
    • View it on ReDoc
    • View it on Swagger Editor
  • For changes between v0.10.0-rc and v0.9.0 see the CHANGELOG.md

• The latest available and released version 0.9.0 of the API is available within the release-0.9.0 branch

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

• Provider implementations (PI) are available within separate repositories:

  • QualityOnDemand_PI1 by Deutsche Telekom
  • QualityOnDemand_PI2 by Orange
  • QualityOnDemand_PI3 by Spry Fox Networks

Contributorship and mailing list

• To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit https://lists.camaraproject.org/g/sp-qod.
• A message to all Contributors of this Sub Project can be sent using [email protected].