QualityOnDemand

Incubating API Repository to evolve and maintain the definitions and documentation of QualityOnDemand Service API(s) within the Sub Project Quality On Demand

Scope

• Service APIs for “Quality on Demand” (see APIBacklog.md)
• The Service APIs provide the API consumer with the ability to:
  • retrieve the possible quality options (profiles) from the network (qos-profiles)
  • set the quality for a connection of a mobile device or a home device within the access network
    • dynamically, for a selected session of a specific duration (quality-on-demand)
    • provisioned, applying the same quality each time the device connects to the network (qod-provisioning)
  • get a notification if the network cannot fulfill the requested quality profile (quality-on-demand, qod-provisioning)
• Describe, develop, document and test the APIs (with 1–2 Service Providers)
• Started: October 2021
• Incubating stage since: February 2025

Release Information

• 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 public release.

• The latest public release is r2.2, with the following API versions:

  • quality-on-demand v1.0.0 (first stable version)
    [YAML] [View it on ReDoc] [View it on Swagger Editor]

  • qos-profiles v1.0.0 (first stable version)
    [YAML] [View it on ReDoc] [View it on Swagger Editor]

  • qod-provisioning v0.2.0 (second initial version)
    [YAML] [View it on ReDoc] [View it on Swagger Editor]

• Previous releases and pre-releases are available here: https://github.com/camaraproject/QualityOnDemand/releases

• For changes see the CHANGELOG.md

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

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

Contributing

• Meetings are held virtually
  • Schedule: bi-weekly, Friday, 13:00 UTC (14:00 CET, 15:00 CEST). For date/time of the next meeting, see previous meeting minutes
  • Registration / Join
  • Minutes: Access meeting minutes
• Mailing List
  • Subscribe / unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-qod.
  • A message to the community of this Sub Project can be sent using [email protected].