Skip to content

Commit

Permalink
Merge pull request #215 from akoshunyadi/update-documentation-for-rea…
Browse files Browse the repository at this point in the history
…chability-data

Update description of the reachability types
  • Loading branch information
akoshunyadi authored Oct 5, 2024
2 parents b424c94 + 9f3f597 commit ca578f3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ info:
When subscribing, it is mandatory to provide the event `types` you are subscribing to, as multiple subscription-types are managed by this API.
Following event ``types`` are managed for this API:
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data``: Event triggered when the device is connected to the network for Data usage.
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data``: Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms``: Event triggered when the device is connected to the network for SMS usage
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms``: Event triggered when the device is connected to the network only for SMS usage
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected``: Event triggered when the device is not connected.
Expand Down Expand Up @@ -675,9 +675,9 @@ components:
NotificationEventType:
type: string
description: |
reachability-data - Event triggered when the device is connected to the network for Data usage.
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
reachability-sms - Event triggered when the device is connected to the network for SMS usage
reachability-sms - Event triggered when the device is connected to the network only for SMS usage
reachability-disconnected - Event triggered when the device is not connected.
Expand All @@ -691,9 +691,9 @@ components:
SubscriptionEventType:
type: string
description: |
reachability-data - Event triggered when the device is connected to the network for Data usage.
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
reachability-sms - Event triggered when the device is connected to the network for SMS usage
reachability-sms - Event triggered when the device is connected to the network only for SMS usage
reachability-disconnected - Event triggered when the device is not connected.
Expand Down
8 changes: 4 additions & 4 deletions code/API_definitions/device-reachability-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ info:
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
* **Reachability** : Reachability status.
- `CONNECTED_SMS`, if device is connected to the network via SMS usage
- `CONNECTED_DATA`, if device is connected to the network via data usage
- `CONNECTED_SMS`, if device is connected to the network only via SMS usage
- `CONNECTED_DATA`, if device is connected to the network via data usage (regardless of the SMS reachability)
- `NOT_CONNECTED`, if device is not connected to the network
* **LastStatusTime** : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain.
Expand Down Expand Up @@ -186,9 +186,9 @@ components:
$ref: "#/components/schemas/ReachabilityStatus"
ReachabilityStatus:
description: |
CONNECTED_DATA: The device is connected to the network for Data usage
CONNECTED_DATA: The device is connected to the network for Data usage (regardless of the SMS reachability)
CONNECTED_SMS: The device is connected to the network for SMS usage
CONNECTED_SMS: The device is connected to the network only for SMS usage
NOT_CONNECTED: The device is not connected
type: string
Expand Down

0 comments on commit ca578f3

Please sign in to comment.