Skip to content

Commit 7137f5e

Browse files
authored
clarify card.usage.* apis only track cell/wifi (#253)
1 parent fb55b1c commit 7137f5e

4 files changed

Lines changed: 15 additions & 9 deletions

card.usage.get.req.notecard.api.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.usage.get.req.notecard.api.json",
44
"title": "card.usage.get Request Application Programming Interface (API) Schema",
5-
"description": "Returns the card's network usage statistics.",
5+
"description": "Returns the Notecard's network usage statistics for cellular and Wi-Fi transmissions.",
66
"type": "object",
77
"version": "1.1.2",
88
"apiVersion": "9.1.1",
@@ -80,13 +80,13 @@
8080
"annotations": [
8181
{
8282
"title": "note",
83-
"description": "Usage data is updated by the Notecard at the end of each network connection. If connected in `continuous` mode, usage data will not be updated until the current session ends, which you can [configure with the `hub.set` `duration` argument](https://dev.blues.io/api-reference/notecard-api/hub-requests/#hub-set)."
83+
"description": "Usage data is updated by the Notecard at the end of each session. If connected in `continuous` mode, usage data will not be updated until the current session ends, which you can [configure with the `hub.set` `duration` argument](https://dev.blues.io/api-reference/notecard-api/hub-requests/#hub-set).\n\nPlease note that the `card.usage.get` API only applies to cellular and Wi-Fi data, not LoRa or satellite (NTN)."
8484
}
8585
],
8686
"samples": [
8787
{
8888
"title": "Get Total Usage",
89-
"description": "Retrieve all usage statistics since Notecard activation.",
89+
"description": "Retrieve all cellular and Wi-Fi usage statistics since Notecard activation.",
9090
"json": "{\"req\": \"card.usage.get\"}"
9191
},
9292
{

card.usage.get.rsp.notecard.api.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.usage.get.rsp.notecard.api.json",
44
"title": "card.usage.get Response Application Programming Interface (API) Schema",
5-
"description": "Response containing network usage statistics for the specified time period.",
5+
"description": "Response containing cellular and Wi-Fi network usage statistics for the specified time period.",
66
"type": "object",
77
"version": "1.1.2",
88
"apiVersion": "9.1.1",
@@ -49,12 +49,12 @@
4949
"samples": [
5050
{
5151
"title": "Complete Usage Statistics",
52-
"description": "Example response showing comprehensive network usage data.",
52+
"description": "Example response showing comprehensive cellular and Wi-Fi network usage data.",
5353
"json": "{\"seconds\":1291377, \"time\":1598479763, \"bytes_sent\":163577, \"bytes_received\":454565, \"notes_sent\":114, \"notes_received\":26, \"sessions_standard\":143, \"sessions_secure\":31}"
5454
},
5555
{
5656
"title": "Partial Usage Statistics",
57-
"description": "Example response with basic usage metrics.",
57+
"description": "Example response with basic cellular and Wi-Fi usage metrics.",
5858
"json": "{\"seconds\":3600, \"time\":1700000000, \"bytes_sent\":1024, \"bytes_received\":2048}"
5959
}
6060
]

card.usage.test.req.notecard.api.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.usage.test.req.notecard.api.json",
44
"title": "card.usage.test Request Application Programming Interface (API) Schema",
5-
"description": "Calculates a projection of how long the available data quota will last based on the observed usage patterns.",
5+
"description": "Calculates a projection of how long the available cellular data quota will last based on the observed usage patterns.",
66
"type": "object",
77
"version": "1.1.2",
88
"apiVersion": "9.1.1",
@@ -21,7 +21,7 @@
2121
"type": "integer"
2222
},
2323
"megabytes": {
24-
"description": "The Notecard lifetime data quota (in megabytes) to use for the test.",
24+
"description": "The Notecard lifetime cellular data quota (in megabytes) to use for the test.",
2525
"type": "integer",
2626
"default": 1024
2727
},
@@ -57,6 +57,12 @@
5757
}
5858
],
5959
"additionalProperties": false,
60+
"annotations": [
61+
{
62+
"title": "note",
63+
"description": "The `card.usage.test` API only applies to cellular and Wi-Fi data, not LoRa or satellite (NTN)."
64+
}
65+
],
6066
"samples": [
6167
{
6268
"title": "Test 7-Day Usage Projection",

card.usage.test.rsp.notecard.api.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.usage.test.rsp.notecard.api.json",
44
"title": "card.usage.test Response Application Programming Interface (API) Schema",
5-
"description": "Response containing data usage projection and analysis results.",
5+
"description": "Response containing cellular data usage projection and analysis results.",
66
"type": "object",
77
"version": "1.1.2",
88
"apiVersion": "9.1.1",

0 commit comments

Comments
 (0)