summaryrefslogtreecommitdiffstats
path: root/src/commands/ping.json
blob: b634c0be006aa0f236a3246dbe0c729b2a2a44a4 (plain)
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
{
    "PING": {
        "summary": "Returns the server's liveliness response.",
        "complexity": "O(1)",
        "group": "connection",
        "since": "1.0.0",
        "arity": -1,
        "function": "pingCommand",
        "command_flags": [
            "FAST",
            "SENTINEL"
        ],
        "acl_categories": [
            "CONNECTION"
        ],
        "command_tips": [
            "REQUEST_POLICY:ALL_SHARDS",
            "RESPONSE_POLICY:ALL_SUCCEEDED"
        ],
        "reply_schema": {
            "anyOf": [
                {
                    "const": "PONG",
                    "description": "Default reply."
                },
                {
                    "type": "string",
                    "description": "Relay of given `message`."
                }
            ]
        },
        "arguments": [
            {
                "name": "message",
                "type": "string",
                "optional": true
            }
        ]
    }
}