notecard-schema/card.binary.req.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
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.binary.req.notecard.api.json",
    "title": "card.binary Request Application Programming Interface (API) Schema",
    "description": "View the status of the binary storage area of the Notecard and optionally clear any data and related `card.binary` variables. See the guide on [Sending and Receiving Large Binary Objects](/guides-and-tutorials/notecard-guides/sending-and-receiving-large-binary-objects) for best practices when using `card.binary`.",
    "type": "object",
    "minApiVersion": "5.3.1",
    "skus": [
        "CELL",
        "CELL+WIFI",
        "SKYLO",
        "WIFI"
    ],
    "properties": {
        "delete": {
            "description": "Clear the COBS area on the Notecard and reset all related arguments previously set by a card.binary request.",
            "type": "boolean"
        },
        "req": {
            "description": "Request for the Notecard (expects response)",
            "const": "card.binary"
        },
        "cmd": {
            "description": "Command for the Notecard (no response)",
            "const": "card.binary"
        }
    },
    "oneOf": [
        {
            "required": [
                "req"
            ],
            "properties": {
                "req": {
                    "const": "card.binary"
                }
            }
        },
        {
            "required": [
                "cmd"
            ],
            "properties": {
                "cmd": {
                    "const": "card.binary"
                }
            }
        }
    ],
    "unevaluatedProperties": false,
    "samples": [
        {
            "title": "View Binary Status",
            "description": "Check the status of binary storage area.",
            "json": "{\"req\": \"card.binary\"}"
        },
        {
            "title": "Reset Binary Data",
            "description": "Clear the COBS area and reset binary variables.",
            "json": "{\"req\": \"card.binary\", \"delete\": true}"
        }
    ],
    "links": [
        {
            "title": "Storing Binary Data on Notecard",
            "url": "https://dev.blues.io/guides-and-tutorials/notecard-guides/sending-and-receiving-large-binary-objects/#storing-binary-data-on-notecard"
        },
        {
            "title": "Reading Binary Data from Notecard",
            "url": "https://dev.blues.io/guides-and-tutorials/notecard-guides/sending-and-receiving-large-binary-objects/#reading-binary-data-from-notecard"
        }
    ]
}