README.md

HomeDevicesQoD

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

Scope

• Service APIs for “HomeDevicesQoD” (see APIBacklog.md)
• It provides the customer with the ability to:
  • change, on demand, the desired QoS behaviour for the IP traffic corresponding to a specific user home device.
• Describe, develop, document and test the APIs
• Started: October 2022

Release Information

• Note: Please be aware that the project will have 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.
• NEW: Release r1.2 of API version 0.4.0 is available here
  • API definition with inline documentation:
    • View it on ReDoc
    • View it on Swagger Editor
    • OpenAPI YAML spec file
  • API additional related documentation
• The latest public release is available here: https://github.com/camaraproject/HomeDevicesQoD/releases/latest
• Other releases of this sub project are available in https://github.com/camaraproject/HomeDevicesQoD/releases
• For changes see CHANGELOG.md

Contributing

• Meetings
  • Registration / Join (Microsoft Teams Meeting)
  • Schedule: bi-weekly on demand(*), Thursday, 4:30pm CET.
    • (*)NOTE: The project is currently stable, so meetings will be scheduled according to the needs of the working group participants. Offline updates will be provided on the mailing list as needed instead. If anyone in the working group would like to have one of the following meetings, please send an email to the list and/or open a new issue in the repository so that everyone can keep track of new topics to discuss.
  • Minutes: Access meeting minutes.
• Mailing List
  • Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-hdp.
  • A message to the community of this Sub Project can be sent using [email protected].