githubmirror/redis

src/commands/ping.json

40 строк998 B

Itamar Haber

Overhauls command summaries and man pages. (#11942)

29 мар 2023, 20:48

29 мар 2023, 20:480c3b8b7

{
    "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
            }
        ]
    }
}