notecard-schema/card.transport.rsp.notecard.api.json at master · blues/notecard-schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.transport.rsp.notecard.api.json",
    "title": "card.transport Response Application Programming Interface (API) Schema",
    "description": "Response containing the current connectivity method configuration of the Notecard.",
    "type": "object",
    "version": "1.1.2",
    "apiVersion": "9.1.1",
    "skus": [
        "CELL",
        "CELL+WIFI",
        "WIFI"
    ],
    "properties": {
        "method": {
            "description": "The connectivity method currently enabled on the device.",
            "type": "string",
            "enum": [
                "-",
                "cell",
                "cell-ntn",
                "dual-wifi-cell",
                "ntn",
                "wifi",
                "wifi-cell",
                "wifi-cell-ntn",
                "wifi-ntn"
            ],
            "sub-descriptions": [
                {
                    "const": "-",
                    "description": "The transport mode is set to the device default.",
                    "skus": [
                        "CELL",
                        "CELL+WIFI",
                        "WIFI"
                    ]
                },
                {
                    "const": "cell",
                    "description": "Cellular only is enabled on the device.",
                    "skus": [
                        "CELL",
                        "CELL+WIFI"
                    ]
                },
                {
                    "const": "cell-ntn",
                    "description": "Prioritizes cellular connectivity while falling back to NTN if a cellular connection cannot be established.",
                    "skus": [
                        "CELL",
                        "CELL+WIFI"
                    ]
                },
                {
                    "const": "dual-wifi-cell",
                    "description": "Deprecated form of `\"wifi-cell\"`.",
                    "skus": [
                        "CELL+WIFI"
                    ],
                    "deprecated": true
                },
                {
                    "const": "ntn",
                    "description": "NTN (Non-Terrestrial Network) mode is enabled on the device for use with Starnote.",
                    "skus": [
                        "CELL",
                        "CELL+WIFI",
                        "WIFI"
                    ]
                },
                {
                    "const": "wifi",
                    "description": "WiFi only is enabled on the device.",
                    "skus": [
                        "CELL+WIFI",
                        "WIFI"
                    ]
                },
                {
                    "const": "wifi-cell",
                    "description": "Prioritizes WiFi connectivity while falling back to cellular if a WiFi connection cannot be established. This is the default behavior on Notecard Cell+WiFi.",
                    "skus": [
                        "CELL+WIFI"
                    ]
                },
                {
                    "const": "wifi-cell-ntn",
                    "description": "Prioritizes WiFi connectivity while falling back to cellular, and lastly to NTN.",
                    "skus": [
                        "CELL+WIFI"
                    ]
                },
                {
                    "const": "wifi-ntn",
                    "description": "Prioritizes WiFi connectivity while falling back to NTN if a WiFi connection cannot be established.",
                    "skus": [
                        "CELL+WIFI",
                        "WIFI"
                    ]
                }
            ]
        }
    },
    "required": [
        "method"
    ],
    "additionalProperties": false,
    "samples": [
        {
            "title": "WiFi-Cell Priority Response",
            "description": "Response showing WiFi-cellular priority transport mode is active.",
            "json": "{\"method\": \"wifi-cell\"}"
        },
        {
            "title": "Cellular Only Response",
            "description": "Response showing cellular-only transport mode is active.",
            "json": "{\"method\": \"cell\"}"
        },
        {
            "title": "NTN Mode Response",
            "description": "Response showing NTN (Non-Terrestrial Network) transport mode is active.",
            "json": "{\"method\": \"ntn\"}"
        }
    ]
}