diff options
Diffstat (limited to 'examples/redis-unstable/src/commands/command-docs.json')
| -rw-r--r-- | examples/redis-unstable/src/commands/command-docs.json | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/examples/redis-unstable/src/commands/command-docs.json b/examples/redis-unstable/src/commands/command-docs.json new file mode 100644 index 0000000..75df5b4 --- /dev/null +++ b/examples/redis-unstable/src/commands/command-docs.json | |||
| @@ -0,0 +1,211 @@ | |||
| 1 | { | ||
| 2 | "DOCS": { | ||
| 3 | "summary": "Returns documentary information about one, multiple or all commands.", | ||
| 4 | "complexity": "O(N) where N is the number of commands to look up", | ||
| 5 | "group": "server", | ||
| 6 | "since": "7.0.0", | ||
| 7 | "arity": -2, | ||
| 8 | "container": "COMMAND", | ||
| 9 | "function": "commandDocsCommand", | ||
| 10 | "command_flags": [ | ||
| 11 | "LOADING", | ||
| 12 | "STALE", | ||
| 13 | "SENTINEL" | ||
| 14 | ], | ||
| 15 | "acl_categories": [ | ||
| 16 | "CONNECTION" | ||
| 17 | ], | ||
| 18 | "command_tips": [ | ||
| 19 | "NONDETERMINISTIC_OUTPUT_ORDER" | ||
| 20 | ], | ||
| 21 | "reply_schema": { | ||
| 22 | "description": "A map where each key is a command name, and each value is the documentary information", | ||
| 23 | "type": "object", | ||
| 24 | "additionalProperties": false, | ||
| 25 | "patternProperties": { | ||
| 26 | "^.*$": { | ||
| 27 | "type": "object", | ||
| 28 | "additionalProperties": false, | ||
| 29 | "properties": { | ||
| 30 | "summary": { | ||
| 31 | "description": "short command description", | ||
| 32 | "type": "string" | ||
| 33 | }, | ||
| 34 | "since": { | ||
| 35 | "description": "the Redis version that added the command (or for module commands, the module version).", | ||
| 36 | "type": "string" | ||
| 37 | }, | ||
| 38 | "group": { | ||
| 39 | "description": "the functional group to which the command belongs", | ||
| 40 | "oneOf": [ | ||
| 41 | { | ||
| 42 | "const": "bitmap" | ||
| 43 | }, | ||
| 44 | { | ||
| 45 | "const": "cluster" | ||
| 46 | }, | ||
| 47 | { | ||
| 48 | "const": "connection" | ||
| 49 | }, | ||
| 50 | { | ||
| 51 | "const": "generic" | ||
| 52 | }, | ||
| 53 | { | ||
| 54 | "const": "geo" | ||
| 55 | }, | ||
| 56 | { | ||
| 57 | "const": "hash" | ||
| 58 | }, | ||
| 59 | { | ||
| 60 | "const": "hyperloglog" | ||
| 61 | }, | ||
| 62 | { | ||
| 63 | "const": "list" | ||
| 64 | }, | ||
| 65 | { | ||
| 66 | "const": "module" | ||
| 67 | }, | ||
| 68 | { | ||
| 69 | "const": "pubsub" | ||
| 70 | }, | ||
| 71 | { | ||
| 72 | "const": "scripting" | ||
| 73 | }, | ||
| 74 | { | ||
| 75 | "const": "sentinel" | ||
| 76 | }, | ||
| 77 | { | ||
| 78 | "const": "server" | ||
| 79 | }, | ||
| 80 | { | ||
| 81 | "const": "set" | ||
| 82 | }, | ||
| 83 | { | ||
| 84 | "const": "sorted-set" | ||
| 85 | }, | ||
| 86 | { | ||
| 87 | "const": "stream" | ||
| 88 | }, | ||
| 89 | { | ||
| 90 | "const": "string" | ||
| 91 | }, | ||
| 92 | { | ||
| 93 | "const": "transactions" | ||
| 94 | } | ||
| 95 | ] | ||
| 96 | }, | ||
| 97 | "complexity": { | ||
| 98 | "description": "a short explanation about the command's time complexity.", | ||
| 99 | "type": "string" | ||
| 100 | }, | ||
| 101 | "module": { | ||
| 102 | "type": "string" | ||
| 103 | }, | ||
| 104 | "doc_flags": { | ||
| 105 | "description": "an array of documentation flags", | ||
| 106 | "type": "array", | ||
| 107 | "items": { | ||
| 108 | "oneOf": [ | ||
| 109 | { | ||
| 110 | "description": "the command is deprecated.", | ||
| 111 | "const": "deprecated" | ||
| 112 | }, | ||
| 113 | { | ||
| 114 | "description": "a system command that isn't meant to be called by users.", | ||
| 115 | "const": "syscmd" | ||
| 116 | } | ||
| 117 | ] | ||
| 118 | } | ||
| 119 | }, | ||
| 120 | "deprecated_since": { | ||
| 121 | "description": "the Redis version that deprecated the command (or for module commands, the module version)", | ||
| 122 | "type": "string" | ||
| 123 | }, | ||
| 124 | "replaced_by": { | ||
| 125 | "description": "the alternative for a deprecated command.", | ||
| 126 | "type": "string" | ||
| 127 | }, | ||
| 128 | "history": { | ||
| 129 | "description": "an array of historical notes describing changes to the command's behavior or arguments.", | ||
| 130 | "type": "array", | ||
| 131 | "items": { | ||
| 132 | "type": "array", | ||
| 133 | "minItems": 2, | ||
| 134 | "maxItems": 2, | ||
| 135 | "items": [ | ||
| 136 | { | ||
| 137 | "type": "string", | ||
| 138 | "description": "The Redis version that the entry applies to." | ||
| 139 | }, | ||
| 140 | { | ||
| 141 | "type": "string", | ||
| 142 | "description": "The description of the change." | ||
| 143 | } | ||
| 144 | ] | ||
| 145 | } | ||
| 146 | }, | ||
| 147 | "arguments": { | ||
| 148 | "description": "an array of maps that describe the command's arguments.", | ||
| 149 | "type": "array", | ||
| 150 | "items": { | ||
| 151 | "type": "object", | ||
| 152 | "additionalProperties": false, | ||
| 153 | "properties": { | ||
| 154 | "name": { | ||
| 155 | "type": "string" | ||
| 156 | }, | ||
| 157 | "type": { | ||
| 158 | "type": "string" | ||
| 159 | }, | ||
| 160 | "display_text": { | ||
| 161 | "type": "string" | ||
| 162 | }, | ||
| 163 | "key_spec_index": { | ||
| 164 | "type": "integer" | ||
| 165 | }, | ||
| 166 | "token": { | ||
| 167 | "type": "string" | ||
| 168 | }, | ||
| 169 | "summary": { | ||
| 170 | "type": "string" | ||
| 171 | }, | ||
| 172 | "since": { | ||
| 173 | "type": "string" | ||
| 174 | }, | ||
| 175 | "deprecated_since": { | ||
| 176 | "type": "string" | ||
| 177 | }, | ||
| 178 | "flags": { | ||
| 179 | "type": "array", | ||
| 180 | "items": { | ||
| 181 | "type": "string" | ||
| 182 | } | ||
| 183 | }, | ||
| 184 | "arguments": { | ||
| 185 | "type": "array" | ||
| 186 | } | ||
| 187 | } | ||
| 188 | } | ||
| 189 | }, | ||
| 190 | "reply_schema": { | ||
| 191 | "description": "command reply schema", | ||
| 192 | "type": "object" | ||
| 193 | }, | ||
| 194 | "subcommands": { | ||
| 195 | "description": "A map where each key is a subcommand, and each value is the documentary information", | ||
| 196 | "$ref": "#" | ||
| 197 | } | ||
| 198 | } | ||
| 199 | } | ||
| 200 | } | ||
| 201 | }, | ||
| 202 | "arguments": [ | ||
| 203 | { | ||
| 204 | "name": "command-name", | ||
| 205 | "type": "string", | ||
| 206 | "optional": true, | ||
| 207 | "multiple": true | ||
| 208 | } | ||
| 209 | ] | ||
| 210 | } | ||
| 211 | } | ||