search

camaraproject / DeviceStatus

Repository to describe, develop, document and test the Device Status API family
Apache License 2.0
11 stars 33 forks source link

Proposed Sub-Project Scope Enhancement: Device Quality Indicator API #176

Closed eric-murray closed 3 months ago

eric-murray commented 5 months ago

Problem description On behalf of the Open Gateway Product Workstream, Deutsche Telekom (via @NoelWirzius) have introduced a new Device Quality Indicator API proposal to the API Backlog WG, and Vodafone are amongst the supporters of this proposal. The API description can be found here, and I also replicate the description below:

The API enables App Developers to get insights about the network status of a defined mobile device. For this the API will return an indicator which is bundling information about the device network status such as availability, open data volume, congestion, historical congestion or the connectivity status (2G, 3G, 4G, 5G). The API service will also alert the consumers when an indicator changes. This API would be useful for applications that optimize user experience based on the connectivity status of a defined device.

The "indicator" would probably follow the traffic light (RAG) standard, but still to be agreed. "Open data volume" would be obtained from a new API - Device Data Volume - and the two APIs would be developed jointly.

The two APIs have been approved, but need a home

Possible evolution During discussion in API Backlog, it was agreed that the existing Device Status Sub-Project would be the best fit for these two APIs. The proposal is to create a separate repository or repositories for these APIs, but discuss them within the existing Device Status meetings (as envisaged by the agreed proposal on "API Families").

Although it is proposed that the new API will also make use of the Connectivity Insights API in addition to the existing Device Status API when constructing the bundled metric, the Device Status Sub-Project was identified as being a better fit as the home for these new APIs as the usage model (one off requests or status change alerts) is the same as that adopted by Device Status, rather than the "monitoring" approach adopted by Connectivity Insights.

I'm opening this issue to formally request that the Device Status Sub-Project adopt these APIs as part of the Device Status family.

Alternative solution

Additional context

bigludo7 commented 4 months ago

This is fine for Orange to welcome Device Quality Indicator API in our sub-project :)

hdamker commented 4 months ago

Deutsche Telekom supports the adoption of the two APIs within the "family" of DeviceStatus. Obviously :)

eric-murray commented 4 months ago

@camaraproject/device-status_maintainers I wasn't able to join the meeting today. Is it now approved that these two APIs can be part of the Device Status sub-project? Thanks.

NoelWirzius commented 4 months ago

@eric-murray yes it is approved, but will not be in scope for the 0.6.0 (Fall release) of Device Status.

eric-murray commented 3 months ago

Closing as completed