ConnectivityInsights

Sandbox API Repository to describe, develop, document, and test the ConnectivityInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.

• API Repository wiki page

Scope

• Service APIs for “Connectivity Insights” (see APIBacklog.md)
• It provides the API consumer with the ability to:
  • share key details about their applications that are relevant for network-related decisions across various CAMARA APIs.
  • gain visibility into network quality, allowing them to check if their application's network requirements can be met for a given user session. Based on the API’s response, developers can make informed decisions - like requesting a network boost through CAMARA Quality on Demand API or adjusting application settings (e.g. adjust video resolution) to ensure the best possible user experience.
  • enables application developers to receive continuous updates about network quality through event notifications.
  • NOTE: The scope of these APIs 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: November 2023

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 available release.

• NEW: This public release r2.2 features the following APIs:

  • r2.2 release of connectivity insights with the following API definitions:

    • Connectivity Insights API v0.5.0 [View it on ReDoc] [View it on Swagger Editor] [OpenAPI]

    • Connectivity Insights Subscriptions API v0.5.0 [View it on ReDoc] [View it on Swagger Editor] [OpenAPI]

    • Application Profiles API 0.4.0 [View it on ReDoc] [View it on Swagger Editor] [OpenAPI]

• The latest public release is available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest

• Other releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases

• For changes see CHANGELOG.md

Contributing

• Meetings
  • Registration / Join
  • Schedule: Bi-weekly on Wednesday at 1500UTC
  • Minutes: Access meeting minutes
• Mailing List
  • Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-coi.
  • A message to the community of this Sub Project can be sent using [email protected].