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 flow within an access network connections (e.g. mobile device connection or fixed access between a home gateway and the service providers gateway router)
    • Session mode, for a specific duration
    • Provision mode, indefinitely for each time the device connects to the same access network
  • get notification if the network cannot fulfill
• Describe, develop, document and test the APIs (with 1–2 Service Providers)
• Started: October 2021

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 r1.2 with the following API definitions:

  • quality-on-demand v0.11.0
    [YAML] [View it on ReDoc] [View it on Swagger Editor]

  • qos-profiles v0.11.0
    [YAML] [View it on ReDoc] [View it on Swagger Editor]

  • qod-provisioning v0.1.0 (new, first 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 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, 2 PM CET/CEST (13:00 UTC, 12:00 UTC during European DST). 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 sp-qod@lists.camaraproject.org.