Connectivity Insights

Repository to describe, develop, document and test the Connectivity Insights API family

Scope

• Service APIs for “Connectivity Insights” (see APIBacklog.md)
• It provides the customer with the ability to:
  • define intents in the form of policy thresholds for QoS metrics against the device and the application service. The API service will alert the consumers if and when the policy has breached.
  • 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: 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.

• r1.2 is the first public release of connectivity insights with the following API definitions:

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

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

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

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

• Note: This being the first public release of the API, list of changes as compared to previous public release is not applicable and hence not provided.

Contributing

• Meetings
  • Registration / Join
  • Schedule: Bi-weekly on Wednesday at 8AM PST
  • 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 sp-coi@lists.camaraproject.org.