summaryrefslogtreecommitdiffstats
path: root/src/commands/command-docs.json
blob: 75df5b4c65dd81c02afd9474466a7a4f93108edf (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
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
{
    "DOCS": {
        "summary": "Returns documentary information about one, multiple or all commands.",
        "complexity": "O(N) where N is the number of commands to look up",
        "group": "server",
        "since": "7.0.0",
        "arity": -2,
        "container": "COMMAND",
        "function": "commandDocsCommand",
        "command_flags": [
            "LOADING",
            "STALE",
            "SENTINEL"
        ],
        "acl_categories": [
            "CONNECTION"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT_ORDER"
        ],
        "reply_schema": {
            "description": "A map where each key is a command name, and each value is the documentary information",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^.*$": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "summary": {
                            "description": "short command description",
                            "type": "string"
                        },
                        "since": {
                            "description": "the Redis version that added the command (or for module commands, the module version).",
                            "type": "string"
                        },
                        "group": {
                            "description": "the functional group to which the command belongs",
                            "oneOf": [
                                {
                                    "const": "bitmap"
                                },
                                {
                                    "const": "cluster"
                                },
                                {
                                    "const": "connection"
                                },
                                {
                                    "const": "generic"
                                },
                                {
                                    "const": "geo"
                                },
                                {
                                    "const": "hash"
                                },
                                {
                                    "const": "hyperloglog"
                                },
                                {
                                    "const": "list"
                                },
                                {
                                    "const": "module"
                                },
                                {
                                    "const": "pubsub"
                                },
                                {
                                    "const": "scripting"
                                },
                                {
                                    "const": "sentinel"
                                },
                                {
                                    "const": "server"
                                },
                                {
                                    "const": "set"
                                },
                                {
                                    "const": "sorted-set"
                                },
                                {
                                    "const": "stream"
                                },
                                {
                                    "const": "string"
                                },
                                {
                                    "const": "transactions"
                                }
                            ]
                        },
                        "complexity": {
                            "description": "a short explanation about the command's time complexity.",
                            "type": "string"
                        },
                        "module": {
                            "type": "string"
                        },
                        "doc_flags": {
                            "description": "an array of documentation flags",
                            "type": "array",
                            "items": {
                                "oneOf": [
                                    {
                                        "description": "the command is deprecated.",
                                        "const": "deprecated"
                                    },
                                    {
                                        "description": "a system command that isn't meant to be called by users.",
                                        "const": "syscmd"
                                    }
                                ]
                            }
                        },
                        "deprecated_since": {
                            "description": "the Redis version that deprecated the command (or for module commands, the module version)",
                            "type": "string"
                        },
                        "replaced_by": {
                            "description": "the alternative for a deprecated command.",
                            "type": "string"
                        },
                        "history": {
                            "description": "an array of historical notes describing changes to the command's behavior or arguments.",
                            "type": "array",
                            "items": {
                                "type": "array",
                                "minItems": 2,
                                "maxItems": 2,
                                "items": [
                                    {
                                        "type": "string",
                                        "description": "The Redis version that the entry applies to."
                                    },
                                    {
                                        "type": "string",
                                        "description": "The description of the change."
                                    }
                                ]
                            }
                        },
                        "arguments": {
                            "description": "an array of maps that describe the command's arguments.",
                            "type": "array",
                            "items": {
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "name": {
                                        "type": "string"
                                    },
                                    "type": {
                                        "type": "string"
                                    },
                                    "display_text": {
                                        "type": "string"
                                    },
                                    "key_spec_index": {
                                        "type": "integer"
                                    },
                                    "token": {
                                        "type": "string"
                                    },
                                    "summary": {
                                        "type": "string"
                                    },
                                    "since": {
                                        "type": "string"
                                    },
                                    "deprecated_since": {
                                        "type": "string"
                                    },
                                    "flags": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "arguments": {
                                        "type": "array"
                                    }
                                }
                            }
                        },
                        "reply_schema": {
                            "description": "command reply schema",
                            "type": "object"
                        },
                        "subcommands": {
                            "description": "A map where each key is a subcommand, and each value is the documentary information",
                            "$ref": "#"
                        }
                    }
                }
            }
        },
        "arguments": [
            {
                "name": "command-name",
                "type": "string",
                "optional": true,
                "multiple": true
            }
        ]
    }
}