From df5e47bae4596389542968cd8e09ba24b7f2099c Mon Sep 17 00:00:00 2001 From: Noel Wirzius <87701895+NoelWirzius@users.noreply.github.com> Date: Fri, 19 Jan 2024 14:53:16 +0100 Subject: [PATCH 1/3] initial commit --- .../APIproposal_Device_Quality_Indicator.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md new file mode 100644 index 00000000..d0d22ac9 --- /dev/null +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md @@ -0,0 +1,13 @@ +API : Device Status Indicator + + +| Field | Description | +| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| API name | Device Quality Indicator | +| API owner | Deutsche Telekom (Noel Wirzius) | +| API Contributors | OpenGateway (Noel Wirzius) | +| API summary | The API enables App Developers to get insights about the network status of a defined device. For this the API will return an indicator which is bundeling information about the device network status such as availibilty, open datavolume, congjestion, historical congjestion or the connecitvity 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 connecitvity status of a defined device. | +| Technical viability | The type of ndata required for this API can be categorized into 4 groups as listed below
1\. User data
2\. Network Data
3\. Historical data
4\. Device Data

The following inputs are suggested as a first scope for the indicator:
- Device Avalibilty (https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0-rc)
- Network Insights ( https://github.com/camaraproject/WorkingGroups/blob/main/APIBacklog/documentation/SupportingDocuments/API%20proposals/APIproposal_NetworkInsights_Verizon.md)
- connection standard (2g,3g,4g,5g)
- Remaining datavolume of the contract
- Speed limitations of the contract | +| Commercial viability | This API was requested by different content providers. It helps them to set up the right content quality in their applications. | +| YAML code available? | No | +| Validated in lab/productive environments? | No From a912a8c6e5a615cf228f6fe5f53c5586224b4aaf Mon Sep 17 00:00:00 2001 From: Noel Wirzius <87701895+NoelWirzius@users.noreply.github.com> Date: Wed, 21 Feb 2024 14:20:42 +0100 Subject: [PATCH 2/3] Update APIproposal_Device_Quality_Indicator.md Changed to the new API Template --- .../APIproposal_Device_Quality_Indicator.md | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md index d0d22ac9..3a401f87 100644 --- a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md @@ -1,13 +1,11 @@ -API : Device Status Indicator - - -| Field | Description | -| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| API name | Device Quality Indicator | -| API owner | Deutsche Telekom (Noel Wirzius) | -| API Contributors | OpenGateway (Noel Wirzius) | -| API summary | The API enables App Developers to get insights about the network status of a defined device. For this the API will return an indicator which is bundeling information about the device network status such as availibilty, open datavolume, congjestion, historical congjestion or the connecitvity 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 connecitvity status of a defined device. | -| Technical viability | The type of ndata required for this API can be categorized into 4 groups as listed below
1\. User data
2\. Network Data
3\. Historical data
4\. Device Data

The following inputs are suggested as a first scope for the indicator:
- Device Avalibilty (https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0-rc)
- Network Insights ( https://github.com/camaraproject/WorkingGroups/blob/main/APIBacklog/documentation/SupportingDocuments/API%20proposals/APIproposal_NetworkInsights_Verizon.md)
- connection standard (2g,3g,4g,5g)
- Remaining datavolume of the contract
- Speed limitations of the contract | -| Commercial viability | This API was requested by different content providers. It helps them to set up the right content quality in their applications. | -| YAML code available? | No | -| Validated in lab/productive environments? | No +| **Field** | Description | +| ---- | ----- | +| API family name |Device Quality Indicator | +| API family owner | Deutsche Telekom (Noel Wirzius)| +| API summary | The API enables App Developers to get insights about the network status of a defined device. For this the API will return an indicator which is bundeling information about the device network status such as availibilty, open datavolume, congjestion, historical congjestion or the connecitvity 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 connecitvity status of a defined device.| +| Technical viability | The type of ndata required for this API can be categorized into 4 groups as listed below
1\. User data
2\. Network Data
3\. Historical data
4\. Device Data

The following inputs are suggested as a first scope for the indicator:
- Device Avalibilty (https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0-rc)
- Network Insights ( https://github.com/camaraproject/WorkingGroups/blob/main/APIBacklog/documentation/SupportingDocuments/API%20proposals/APIproposal_NetworkInsights_Verizon.md)
- connection standard (2g,3g,4g,5g)
- Remaining datavolume of the contract
- Speed limitations of the contract| +| Commercial viability | This API was requested by different content providers. It helps them to set up the right content quality in their applications.| +| YAML code available? | NO. | +| Validated in lab/productive environments? | NO| +| Validated with operators? | NO | +| Supporters in API Backlog Working Group | | From 6601e0459628635036bb02cfc6dcee28605ff148 Mon Sep 17 00:00:00 2001 From: Noel Wirzius <87701895+NoelWirzius@users.noreply.github.com> Date: Thu, 22 Feb 2024 15:46:42 +0100 Subject: [PATCH 3/3] Update and rename APIproposal_Device_Quality_Indicator.md to APIproposal_Device_Connection_Quality_Indicator.md --- ....md => APIproposal_Device_Connection_Quality_Indicator.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename APIBacklog/documentation/SupportingDocuments/API proposals/{APIproposal_Device_Quality_Indicator.md => APIproposal_Device_Connection_Quality_Indicator.md} (68%) diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Connection_Quality_Indicator.md similarity index 68% rename from APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md rename to APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Connection_Quality_Indicator.md index 3a401f87..35b8ed8b 100644 --- a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Quality_Indicator.md +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_Device_Connection_Quality_Indicator.md @@ -1,8 +1,8 @@ | **Field** | Description | | ---- | ----- | -| API family name |Device Quality Indicator | +| API family name |Device Connection Quality Indicator | | API family owner | Deutsche Telekom (Noel Wirzius)| -| API summary | The API enables App Developers to get insights about the network status of a defined device. For this the API will return an indicator which is bundeling information about the device network status such as availibilty, open datavolume, congjestion, historical congjestion or the connecitvity 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 connecitvity status of a defined device.| +| API summary | 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 bundeling information about the device network status such as availibilty, open datavolume, congjestion, historical congjestion or the connecitvity 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 connecitvity status of a defined device.| | Technical viability | The type of ndata required for this API can be categorized into 4 groups as listed below
1\. User data
2\. Network Data
3\. Historical data
4\. Device Data

The following inputs are suggested as a first scope for the indicator:
- Device Avalibilty (https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0-rc)
- Network Insights ( https://github.com/camaraproject/WorkingGroups/blob/main/APIBacklog/documentation/SupportingDocuments/API%20proposals/APIproposal_NetworkInsights_Verizon.md)
- connection standard (2g,3g,4g,5g)
- Remaining datavolume of the contract
- Speed limitations of the contract| | Commercial viability | This API was requested by different content providers. It helps them to set up the right content quality in their applications.| | YAML code available? | NO. |