caleb-brown/redict
1
0
Fork 0
mirror of https://codeberg.org/redict/redict.git synced 2025-01-22 08:08:53 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add reply_schema to command json files (internal for now) (#10273)

Browse Source 
Work in progress towards implementing a reply schema as part of COMMAND DOCS, see #9845
Since ironing the details of the reply schema of each and every command can take a long time, we
would like to merge this PR when the infrastructure is ready, and let this mature in the unstable branch.
Meanwhile the changes of this PR are internal, they are part of the repo, but do not affect the produced build.

### Background
In #9656 we add a lot of information about Redis commands, but we are missing information about the replies

### Motivation
1. Documentation. This is the primary goal.
2. It should be possible, based on the output of COMMAND, to be able to generate client code in typed
  languages. In order to do that, we need Redis to tell us, in detail, what each reply looks like.
3. We would like to build a fuzzer that verifies the reply structure (for now we use the existing
  testsuite, see the "Testing" section)

### Schema
The idea is to supply some sort of schema for the various replies of each command.
The schema will describe the conceptual structure of the reply (for generated clients), as defined in RESP3.
Note that the reply structure itself may change, depending on the arguments (e.g. `XINFO STREAM`, with
and without the `FULL` modifier)
We decided to use the standard json-schema (see https://json-schema.org/) as the reply-schema.

Example for `BZPOPMIN`:
```
"reply_schema": {
    "oneOf": [
        {
            "description": "Timeout reached and no elements were popped.",
            "type": "null"
        },
        {
            "description": "The keyname, popped member, and its score.",
            "type": "array",
            "minItems": 3,
            "maxItems": 3,
            "items": [
                {
                    "description": "Keyname",
                    "type": "string"
                },
                {
                    "description": "Member",
                    "type": "string"
                },
                {
                    "description": "Score",
                    "type": "number"
                }
            ]
        }
    ]
}
```

#### Notes
1.  It is ok that some commands' reply structure depends on the arguments and it's the caller's responsibility
  to know which is the relevant one. this comes after looking at other request-reply systems like OpenAPI,
  where the reply schema can also be oneOf and the caller is responsible to know which schema is the relevant one.
2. The reply schemas will describe RESP3 replies only. even though RESP3 is structured, we want to use reply
  schema for documentation (and possibly to create a fuzzer that validates the replies)
3. For documentation, the description field will include an explanation of the scenario in which the reply is sent,
  including any relation to arguments. for example, for `ZRANGE`'s two schemas we will need to state that one
  is with `WITHSCORES` and the other is without.
4. For documentation, there will be another optional field "notes" in which we will add a short description of
  the representation in RESP2, in case it's not trivial (RESP3's `ZRANGE`'s nested array vs. RESP2's flat
  array, for example)

Given the above:
1. We can generate the "return" section of all commands in [redis-doc](https://redis.io/commands/)
  (given that "description" and "notes" are comprehensive enough)
2. We can generate a client in a strongly typed language (but the return type could be a conceptual
  `union` and the caller needs to know which schema is relevant). see the section below for RESP2 support.
3. We can create a fuzzer for RESP3.

### Limitations (because we are using the standard json-schema)
The problem is that Redis' replies are more diverse than what the json format allows. This means that,
when we convert the reply to a json (in order to validate the schema against it), we lose information (see
the "Testing" section below).
The other option would have been to extend the standard json-schema (and json format) to include stuff
like sets, bulk-strings, error-string, etc. but that would mean also extending the schema-validator - and that
seemed like too much work, so we decided to compromise.

Examples:
1. We cannot tell the difference between an "array" and a "set"
2. We cannot tell the difference between simple-string and bulk-string
3. we cannot verify true uniqueness of items in commands like ZRANGE: json-schema doesn't cover the
  case of two identical members with different scores (e.g. `[["m1",6],["m1",7]]`) because `uniqueItems`
  compares (member,score) tuples and not just the member name. 

### Testing
This commit includes some changes inside Redis in order to verify the schemas (existing and future ones)
are indeed correct (i.e. describe the actual response of Redis).
To do that, we added a debugging feature to Redis that causes it to produce a log of all the commands
it executed and their replies.
For that, Redis needs to be compiled with `-DLOG_REQ_RES` and run with
`--reg-res-logfile <file> --client-default-resp 3` (the testsuite already does that if you run it with
`--log-req-res --force-resp3`)
You should run the testsuite with the above args (and `--dont-clean`) in order to make Redis generate
`.reqres` files (same dir as the `stdout` files) which contain request-response pairs.
These files are later on processed by `./utils/req-res-log-validator.py` which does:
1. Goes over req-res files, generated by redis-servers, spawned by the testsuite (see logreqres.c)
2. For each request-response pair, it validates the response against the request's reply_schema
  (obtained from the extended COMMAND DOCS)
5. In order to get good coverage of the Redis commands, and all their different replies, we chose to use
  the existing redis test suite, rather than attempt to write a fuzzer.

#### Notes about RESP2
1. We will not be able to use the testing tool to verify RESP2 replies (we are ok with that, it's time to
  accept RESP3 as the future RESP)
2. Since the majority of the test suite is using RESP2, and we want the server to reply with RESP3
  so that we can validate it, we will need to know how to convert the actual reply to the one expected.
   - number and boolean are always strings in RESP2 so the conversion is easy
   - objects (maps) are always a flat array in RESP2
   - others (nested array in RESP3's `ZRANGE` and others) will need some special per-command
     handling (so the client will not be totally auto-generated)

Example for ZRANGE:
```
"reply_schema": {
    "anyOf": [
        {
            "description": "A list of member elements",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        {
            "description": "Members and their scores. Returned in case `WITHSCORES` was used.",
            "notes": "In RESP2 this is returned as a flat array",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "array",
                "minItems": 2,
                "maxItems": 2,
                "items": [
                    {
                        "description": "Member",
                        "type": "string"
                    },
                    {
                        "description": "Score",
                        "type": "number"
                    }
                ]
            }
        }
    ]
}
```

### Other changes
1. Some tests that behave differently depending on the RESP are now being tested for both RESP,
  regardless of the special log-req-res mode ("Pub/Sub PING" for example)
2. Update the history field of CLIENT LIST
3. Added basic tests for commands that were not covered at all by the testsuite

### TODO

- [x] (maybe a different PR) add a "condition" field to anyOf/oneOf schemas that refers to args. e.g.
  when `SET` return NULL, the condition is `arguments.get||arguments.condition`, for `OK` the condition
  is `!arguments.get`, and for `string` the condition is `arguments.get` - https://github.com/redis/redis/issues/11896
- [x] (maybe a different PR) also run `runtest-cluster` in the req-res logging mode
- [x] add the new tests to GH actions (i.e. compile with `-DLOG_REQ_RES`, run the tests, and run the validator)
- [x] (maybe a different PR) figure out a way to warn about (sub)schemas that are uncovered by the output
  of the tests - https://github.com/redis/redis/issues/11897
- [x] (probably a separate PR) add all missing schemas
- [x] check why "SDOWN is triggered by misconfigured instance replying with errors" fails with --log-req-res
- [x] move the response transformers to their own file (run both regular, cluster, and sentinel tests - need to
  fight with the tcl including mechanism a bit)
- [x] issue: module API - https://github.com/redis/redis/issues/11898
- [x] (probably a separate PR): improve schemas: add `required` to `object`s - https://github.com/redis/redis/issues/11899

Co-authored-by: Ozan Tezcan <ozantezcan@gmail.com>
Co-authored-by: Hanna Fadida <hanna.fadida@redislabs.com>
Co-authored-by: Oran Agra <oran@redislabs.com>
Co-authored-by: Shaya Potter <shaya@redislabs.com>
This commit is contained in:
guybe7 2023-03-11 09:14:16 +01:00 committed by GitHub
parent c46d68d6d2
commit 4ba47d2d21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
403 changed files with 6762 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/ci.yml vendored
View File

@ -75,3 +75,4 @@ jobs:
run: |
yum -y install gcc make
make REDIS_CFLAGS='-Werror'

43
.github/workflows/daily.yml vendored
View File

@ -11,7 +11,7 @@ on:
inputs:
skipjobs:
description: 'jobs to skip (delete the ones you wanna keep, do not leave empty)'
default: 'valgrind,sanitizer,tls,freebsd,macos,alpine,32bit,iothreads,ubuntu,centos,malloc,specific'
default: 'valgrind,sanitizer,tls,freebsd,macos,alpine,32bit,iothreads,ubuntu,centos,malloc,specific,reply-schema'
skiptests:
description: 'tests to skip (delete the ones you wanna keep, do not leave empty)'
default: 'redis,modules,sentinel,cluster,unittest'
@ -898,3 +898,44 @@ jobs:
- name: cluster tests
if: true && !contains(github.event.inputs.skiptests, 'cluster')
run: ./runtest-cluster ${{github.event.inputs.cluster_test_args}}
reply-schemas-validator:
runs-on: ubuntu-latest
timeout-minutes: 14400
if: |
(github.event_name == 'workflow_dispatch' || (github.event_name != 'workflow_dispatch' && github.repository == 'redis/redis')) &&
!contains(github.event.inputs.skipjobs, 'reply-schema')
steps:
- name: prep
if: github.event_name == 'workflow_dispatch'
run: |
echo "GITHUB_REPOSITORY=${{github.event.inputs.use_repo}}" >> $GITHUB_ENV
echo "GITHUB_HEAD_REF=${{github.event.inputs.use_git_ref}}" >> $GITHUB_ENV
echo "skipping: ${{github.event.inputs.skipjobs}} and ${{github.event.inputs.skiptests}}"
- uses: actions/checkout@v3
with:
repository: ${{ env.GITHUB_REPOSITORY }}
ref: ${{ env.GITHUB_HEAD_REF }}
- name: make
run: make REDIS_CFLAGS='-Werror -DLOG_REQ_RES'
- name: testprep
run: sudo apt-get install tcl8.6 tclx
- name: test
if: true && !contains(github.event.inputs.skiptests, 'redis')
run: ./runtest --log-req-res --dont-clean --force-resp3 --tags -slow --verbose --dump-logs ${{github.event.inputs.test_args}}
- name: module api test
if: true && !contains(github.event.inputs.skiptests, 'modules')
run: ./runtest-moduleapi --log-req-res --dont-clean --force-resp3 --dont-pre-clean --verbose --dump-logs ${{github.event.inputs.test_args}}
- name: sentinel tests
if: true && !contains(github.event.inputs.skiptests, 'sentinel')
run: ./runtest-sentinel --log-req-res --dont-clean --force-resp3 ${{github.event.inputs.cluster_test_args}}
- name: cluster tests
if: true && !contains(github.event.inputs.skiptests, 'cluster')
run: ./runtest-cluster --log-req-res --dont-clean --force-resp3 ${{github.event.inputs.cluster_test_args}}
- name: Install Python dependencies
uses: py-actions/py-dependency-install@v4
with:
path: "./utils/req-res-validator/requirements.txt"
- name: validator
run: ./utils/req-res-log-validator.py --verbose --fail-missing-reply-schemas --fail-commands-not-all-hit

22
.github/workflows/reply-schemas-linter.yml vendored Normal file
View File

@ -0,0 +1,22 @@
name: Reply-schemas linter
on:
push:
paths:
- 'src/commands/*.json'
pull_request:
paths:
- 'src/commands/*.json'
jobs:
reply-schemas-linter:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup nodejs
uses: actions/setup-node@v3
- name: Install packages
run: npm install ajv
- name: linter
run: node ./utils/reply_schema_linter.js

14
src/Makefile
View File

@ -330,9 +330,17 @@ QUIET_LINK = @printf ' %b %b\n' $(LINKCOLOR)LINK$(ENDCOLOR) $(BINCOLOR)$@$(EN
QUIET_INSTALL = @printf ' %b %b\n' $(LINKCOLOR)INSTALL$(ENDCOLOR) $(BINCOLOR)$@$(ENDCOLOR) 1>&2;
endif
ifneq (, $(findstring LOG_REQ_RES, $(REDIS_CFLAGS)))
COMMANDS_FILENAME=commands_with_reply_schema
GEN_COMMANDS_FLAGS=--with-reply-schema
else
COMMANDS_FILENAME=commands
GEN_COMMANDS_FLAGS=
endif
REDIS_SERVER_NAME=redis-server$(PROG_SUFFIX)
REDIS_SENTINEL_NAME=redis-sentinel$(PROG_SUFFIX)
REDIS_SERVER_OBJ=adlist.o quicklist.o ae.o anet.o dict.o server.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o cluster.o crc16.o endianconv.o slowlog.o eval.o bio.o rio.o rand.o memtest.o syscheck.o crcspeed.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperloglog.o latency.o sparkline.o redis-check-rdb.o redis-check-aof.o geo.o lazyfree.o module.o evict.o expire.o geohash.o geohash_helper.o childinfo.o defrag.o siphash.o rax.o t_stream.o listpack.o localtime.o lolwut.o lolwut5.o lolwut6.o acl.o tracking.o socket.o tls.o sha256.o timeout.o setcpuaffinity.o monotonic.o mt19937-64.o resp_parser.o call_reply.o script_lua.o script.o functions.o function_lua.o commands.o strl.o connection.o unix.o
REDIS_SERVER_OBJ=adlist.o quicklist.o ae.o anet.o dict.o server.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o cluster.o crc16.o endianconv.o slowlog.o eval.o bio.o rio.o rand.o memtest.o syscheck.o crcspeed.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperloglog.o latency.o sparkline.o redis-check-rdb.o redis-check-aof.o geo.o lazyfree.o module.o evict.o expire.o geohash.o geohash_helper.o childinfo.o defrag.o siphash.o rax.o t_stream.o listpack.o localtime.o lolwut.o lolwut5.o lolwut6.o acl.o tracking.o socket.o tls.o sha256.o timeout.o setcpuaffinity.o monotonic.o mt19937-64.o resp_parser.o call_reply.o script_lua.o script.o functions.o function_lua.o $(COMMANDS_FILENAME).o strl.o connection.o unix.o logreqres.o
REDIS_CLI_NAME=redis-cli$(PROG_SUFFIX)
REDIS_CLI_OBJ=anet.o adlist.o dict.o redis-cli.o zmalloc.o release.o ae.o redisassert.o crcspeed.o crc64.o siphash.o crc16.o monotonic.o cli_common.o mt19937-64.o strl.o
REDIS_BENCHMARK_NAME=redis-benchmark$(PROG_SUFFIX)
@ -425,8 +433,8 @@ DEP = $(REDIS_SERVER_OBJ:%.o=%.d) $(REDIS_CLI_OBJ:%.o=%.d) $(REDIS_BENCHMARK_OBJ
# The file commands.c is checked in and doesn't normally need to be rebuilt. It
# is built only if python is available and its prereqs are modified.
ifneq (,$(PYTHON))
commands.c: commands/*.json ../utils/generate-command-code.py
$(QUIET_GEN)$(PYTHON) ../utils/generate-command-code.py
$(COMMANDS_FILENAME).c: commands/*.json ../utils/generate-command-code.py
$(QUIET_GEN)$(PYTHON) ../utils/generate-command-code.py $(GEN_COMMANDS_FLAGS)
endif
clean:

7
src/blocked.c
View File

@ -195,6 +195,11 @@ void unblockClient(client *c) {
* or in case a shutdown operation was canceled and we are still in the processCommand sequence */
if (!(c->flags & CLIENT_PENDING_COMMAND) && c->bstate.btype != BLOCKED_SHUTDOWN) {
freeClientOriginalArgv(c);
/* Clients that are not blocked on keys are not reprocessed so we must
* call reqresAppendResponse here (for clients blocked on key,
* unblockClientOnKey is called, which eventually calls processCommand,
* which calls reqresAppendResponse) */
reqresAppendResponse(c);
resetClient(c);
}
@ -612,6 +617,8 @@ static void unblockClientOnKey(client *c, robj *key) {
c->bstate.btype == BLOCKED_LIST ||
c->bstate.btype == BLOCKED_ZSET);
/* We need to unblock the client before calling processCommandAndResetClient
* because it checks the CLIENT_BLOCKED flag */
unblockClient(c);
/* In case this client was blocked on keys during command
* we need to re process the command again */

18
src/commands/acl-cat.json
View File

@ -13,6 +13,24 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"anyOf": [
{
"type": "array",
"description": "In case `categoryname` was not given, a list of existing ACL categories",
"items": {
"type": "string"
}
},
{
"type": "array",
"description": "In case `categoryname` was given, list of commands that fall under the provided ACL category",
"items": {
"type": "string"
}
}
]
},
"arguments": [
{
"name": "categoryname",

4
src/commands/acl-deluser.json
View File

@ -14,6 +14,10 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"type": "integer",
"description": "The number of users that were deleted"
},
"arguments": [
{
"name": "username",

12
src/commands/acl-dryrun.json
View File

@ -15,6 +15,18 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"anyOf": [
{
"const": "OK",
"description": "The given user may successfully execute the given command."
},
{
"type": "string",
"description": "The description of the problem, in case the user is not allowed to run the given command."
}
]
},
"arguments": [
{
"name": "username",

4
src/commands/acl-genpass.json
View File

@ -13,6 +13,10 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"type": "string",
"description": "Pseudorandom data. By default it contains 64 bytes, representing 256 bits of data. If `bits` was given, the output string length is the number of specified bits (rounded to the next multiple of 4) divided by 4."
},
"arguments": [
{
"name": "bits",

57
src/commands/acl-getuser.json
View File

@ -29,6 +29,63 @@
"name": "username",
"type": "string"
}
],
"reply_schema": {
"oneOf": [
{
"description": "a set of ACL rule definitions for the user",
"type": "object",
"additionalProperties": false,
"properties": {
"flags": {
"type": "array",
"items": {
"type": "string"
}
},
"passwords": {
"type": "array",
"items": {
"type": "string"
}
},
"commands": {
"description": "root selector's commands",
"type": "string"
},
"keys": {
"description": "root selector's keys",
"type": "string"
},
"channels": {
"description": "root selector's channels",
"type": "string"
},
"selectors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"commands": {
"type": "string"
},
"keys": {
"type": "string"
},
"channels": {
"type": "string"
}
}
}
}
}
},
{
"description": "If user does not exist",
"type": "null"
}
]
}
}
}

9
src/commands/acl-help.json
View File

@ -11,6 +11,13 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"type": "array",
"description": "A list of subcommands and their description",
"items": {
"type": "string"
}
}
}
}

9
src/commands/acl-list.json
View File

@ -13,6 +13,13 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"type": "array",
"description": "A list of currently active ACL rules",
"items": {
"type": "string"
}
}
}
}

5
src/commands/acl-load.json
View File

@ -13,6 +13,9 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"const": "OK"
}
}
}

48
src/commands/acl-log.json
View File

@ -20,6 +20,54 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"oneOf": [
{
"description": "In case `RESET` was not given, a list of recent ACL security events.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"reason": {
"type": "string"
},
"context": {
"type": "string"
},
"object": {
"type": "string"
},
"username": {
"type": "string"
},
"age-seconds": {
"type": "number"
},
"client-info": {
"type": "string"
},
"entry-id": {
"type": "integer"
},
"timestamp-created": {
"type": "integer"
},
"timestamp-last-updated": {
"type": "integer"
}
}
}
},
{
"const": "OK",
"description": "In case `RESET` was given, OK indicates ACL log was cleared."
}
]
},
"arguments": [
{
"name": "operation",

5
src/commands/acl-save.json
View File

@ -13,6 +13,9 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"const": "OK"
}
}
}

3
src/commands/acl-setuser.json
View File

@ -24,6 +24,9 @@
"STALE",
"SENTINEL"
],
"reply_schema": {
"const": "OK"
},
"arguments": [
{
"name": "username",

9
src/commands/acl-users.json
View File

@ -13,6 +13,13 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"type": "array",
"description": "List of existing ACL users",
"items": {
"type": "string"
}
}
}
}

6
src/commands/acl-whoami.json
View File

@ -12,6 +12,10 @@
"LOADING",
"STALE",
"SENTINEL"
]
],
"reply_schema": {
"type": "string",
"description": "The username of the current connection."
}
}
}

4
src/commands/append.json
View File

@ -34,6 +34,10 @@
}
}
],
"reply_schema": {
"type": "integer",
"description": "The the length of the string after the append operation."
},
"arguments": [
{
"name": "key",

5
src/commands/asking.json
View File

@ -11,6 +11,9 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"const": "OK"
}
}
}

3
src/commands/auth.json
View File

@ -24,6 +24,9 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"const": "OK"
},
"arguments": [
{
"name": "username",

6
src/commands/bgrewriteaof.json
View File

@ -10,6 +10,10 @@
"NO_ASYNC_LOADING",
"ADMIN",
"NOSCRIPT"
]
],
"reply_schema": {
"description": "A simple string reply indicating that the rewriting started or is about to start ASAP",
"type": "string"
}
}
}

10
src/commands/bgsave.json
View File

@ -25,6 +25,16 @@
"optional": true,
"since": "3.2.2"
}
],
"reply_schema": {
"oneOf": [
{
"const": "Background saving started"
},
{
"const": "Background saving scheduled"
}
]
}
}
}

7
src/commands/bitcount.json
View File

@ -77,6 +77,11 @@
}
]
}
]
],
"reply_schema": {
"description": "The number of bits set to 1.",
"type": "integer",
"minimum": 0
}
}
}

15
src/commands/bitfield.json
View File

@ -139,6 +139,21 @@
}
]
}
],
"reply_schema": {
"type": "array",
"items": {
"oneOf": [
{
"description": "The result of the subcommand at the same position",
"type": "integer"
},
{
"description": "In case OVERFLOW FAIL was given and overflows or underflows detected",
"type": "null"
}
]
}
}
}
}

9
src/commands/bitfield_ro.json
View File

@ -57,6 +57,13 @@
}
]
}
]
],
"reply_schema": {
"type": "array",
"items": {
"description": "The result of the subcommand at the same position",
"type": "integer"
}
}
}
}

7
src/commands/bitop.json
View File

@ -89,6 +89,11 @@
"key_spec_index": 1,
"multiple": true
}
]
],
"reply_schema": {
"description": "the size of the string stored in the destination key, that is equal to the size of the longest input string",
"type": "integer",
"minimum": 0
}
}
}

13
src/commands/bitpos.json
View File

@ -88,6 +88,19 @@
}
]
}
],
"reply_schema": {
"oneOf": [
{
"description": "the position of the first bit set to 1 or 0 according to the request",
"type": "integer",
"minimum": 0
},
{
"description": "In case the `bit` argument is 1 and the string is empty or composed of just zero bytes",
"const": -1
}
]
}
}
}

12
src/commands/blmove.json
View File

@ -54,6 +54,18 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "The popped element.",
"type": "string"
},
{
"description": "Operation timed-out",
"type": "null"
}
]
},
"arguments": [
{
"name": "source",

28
src/commands/blmpop.json
View File

@ -35,6 +35,34 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "Operation timed-out",
"type": "null"
},
{
"description": "The key from which elements were popped and the popped elements",
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "List key from which elements were popped.",
"type": "string"
},
{
"description": "Array of popped elements.",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
]
}
]
},
"arguments": [
{
"name": "timeout",

24
src/commands/blpop.json
View File

@ -41,6 +41,30 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"type": "null",
"description": "No element could be popped and timeout expired"
},
{
"description": "The key from which the element was popped and the value of the popped element",
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "List key from which the element was popped.",
"type": "string"
},
{
"description": "Value of the popped element.",
"type": "string"
}
]
}
]
},
"arguments": [
{
"name": "key",

23
src/commands/brpop.json
View File

@ -52,6 +52,29 @@
"name": "timeout",
"type": "double"
}
],
"reply_schema": {
"oneOf": [
{
"description": "No element could be popped and the timeout expired.",
"type": "null"
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "The name of the key where an element was popped ",
"type": "string"
},
{
"description": "The value of the popped element",
"type": "string"
}
]
}
]
}
}
}

12
src/commands/brpoplpush.json
View File

@ -65,6 +65,18 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"type": "string",
"description": "The element being popped from source and pushed to destination."
},
{
"type": "null",
"description": "Timeout is reached."
}
]
},
"arguments": [
{
"name": "source",

40
src/commands/bzmpop.json
View File

@ -35,6 +35,46 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname and the popped members.",
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Popped members and their scores.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
}
]
}
]
},
"arguments": [
{
"name": "timeout",

28
src/commands/bzpopmax.json
View File

@ -42,6 +42,34 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname, popped member, and its score.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
]
},
"arguments": [
{
"name": "key",

28
src/commands/bzpopmin.json
View File

@ -42,6 +42,34 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "Timeout reached and no elements were popped.",
"type": "null"
},
{
"description": "The keyname, popped member, and its score.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "Keyname",
"type": "string"
},
{
"description": "Member",
"type": "string"
},
{
"description": "Score",
"type": "number"
}
]
}
]
},
"arguments": [
{
"name": "key",

3
src/commands/client-caching.json
View File

@ -16,6 +16,9 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"const": "OK"
},
"arguments": [
{
"name": "mode",

12
src/commands/client-getname.json
View File

@ -15,6 +15,18 @@
],
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"oneOf": [
{
"type": "string",
"description": "The connection name of the current connection"
},
{
"type": "null",
"description": "Connection name was not set"
}
]
}
}
}

17
src/commands/client-getredir.json
View File

@ -15,6 +15,23 @@
],
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"oneOf": [
{
"const": 0,
"description": "Not redirecting notifications to any client."
},
{
"const": -1,
"description": "Client tracking is not enabled."
},
{
"type": "integer",
"description": "ID of the client we are redirecting the notifications to.",
"minimum": 1
}
]
}
}
}

9
src/commands/client-help.json
View File

@ -14,6 +14,13 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"type": "array",
"description": "Helpful text about subcommands.",
"items": {
"type": "string"
}
}
}
}

6
src/commands/client-id.json
View File

@ -15,6 +15,10 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"type": "integer",
"description": "The id of the client"
}
}
}

6
src/commands/client-info.json
View File

@ -18,6 +18,10 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
]
],
"reply_schema": {
"description": "a unique string, as described at the CLIENT LIST page, for the current client",
"type": "string"
}
}
}

13
src/commands/client-kill.json
View File

@ -141,6 +141,19 @@
}
]
}
],
"reply_schema": {
"oneOf": [
{
"description": "when called in 3 argument format",
"const": "OK"
},
{
"description": "when called in filter/value format, the number of clients killed",
"type": "integer",
"minimum": 0
}
]
}
}
}

4
src/commands/client-list.json
View File

@ -46,6 +46,10 @@
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"reply_schema": {
"type": "string",
"description": "Information and statistics about client connections"
},
"arguments": [
{
"token": "TYPE",

5
src/commands/client-no-evict.json
View File

@ -34,6 +34,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

3
src/commands/client-no-touch.json
View File

@ -15,6 +15,9 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"const": "OK"
},
"arguments": [
{
"name": "enabled",

5
src/commands/client-pause.json
View File

@ -46,6 +46,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

4
src/commands/client-reply.json
View File

@ -16,6 +16,10 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"const": "OK",
"description": "When called with either OFF or SKIP subcommands, no reply is made. When called with ON, reply is OK."
},
"arguments": [
{
"name": "action",

5
src/commands/client-setname.json
View File

@ -21,6 +21,9 @@
"name": "connection-name",
"type": "string"
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

6
src/commands/client-tracking.json
View File

@ -71,6 +71,10 @@
"type": "pure-token",
"optional": true
}
]
],
"reply_schema": {
"description": "if the client was successfully put into or taken out of tracking mode",
"const": "OK"
}
}
}

60
src/commands/client-trackinginfo.json
View File

@ -15,6 +15,66 @@
],
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"flags": {
"type": "array",
"items": {
"oneOf": [
{
"const": "off",
"description": "The connection isn't using server assisted client side caching."
},
{
"const": "on",
"description": "Server assisted client side caching is enabled for the connection."
},
{
"const": "bcast",
"description": "The client uses broadcasting mode."
},
{
"const": "optin",
"description": "The client does not cache keys by default."
},
{
"const": "optout",
"description": "The client caches keys by default."
},
{
"const": "caching-yes",
"description": "The next command will cache keys (exists only together with optin)."
},
{
"const": "caching-no",
"description": "The next command won't cache keys (exists only together with optout)."
},
{
"const": "noloop",
"description": "The client isn't notified about keys modified by itself."
},
{
"const": "broken_redirect",
"description": "The client ID used for redirection isn't valid anymore."
}
]
}
},
"redirect": {
"type": "integer",
"description": "The client ID used for notifications redirection, or -1 when none."
},
"prefixes": {
"type": "array",
"description": "List of key prefixes for which notifications are sent to the client.",
"items": {
"type": "string"
}
}
}
}
}
}

12
src/commands/client-unblock.json
View File

@ -17,6 +17,18 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"oneOf": [
{
"const": 0,
"description": "if the client was unblocked successfully"
},
{
"const": 1,
"description": "if the client wasn't unblocked"
}
]
},
"arguments": [
{
"name": "client-id",

5
src/commands/client-unpause.json
View File

@ -16,6 +16,9 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-addslots.json
View File

@ -18,6 +18,9 @@
"type": "integer",
"multiple": true
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-addslotsrange.json
View File

@ -28,6 +28,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

14
src/commands/cluster-bumpepoch.json
View File

@ -14,6 +14,20 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"reply_schema": {
"oneOf": [
{
"description": "if the epoch was incremented",
"type": "string",
"pattern": "^BUMPED [0-9]*$"
},
{
"description": "if the node already has the greatest config epoch in the cluster",
"type": "string",
"pattern": "^STILL [0-9]*$"
}
]
}
}
}

7
src/commands/cluster-count-failure-reports.json
View File

@ -19,6 +19,11 @@
"name": "node-id",
"type": "string"
}
]
],
"reply_schema": {
"description": "the number of active failure reports for the node",
"type": "integer",
"minimum": 0
}
}
}

7
src/commands/cluster-countkeysinslot.json
View File

@ -15,6 +15,11 @@
"name": "slot",
"type": "integer"
}
]
],
"reply_schema": {
"description": "The number of keys in the specified hash slot",
"type": "integer",
"minimum": 0
}
}
}

5
src/commands/cluster-delslots.json
View File

@ -18,6 +18,9 @@
"type": "integer",
"multiple": true
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-delslotsrange.json
View File

@ -28,6 +28,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-failover.json
View File

@ -30,6 +30,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-flushslots.json
View File

@ -11,6 +11,9 @@
"NO_ASYNC_LOADING",
"ADMIN",
"STALE"
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-forget.json
View File

@ -17,6 +17,9 @@
"name": "node-id",
"type": "string"
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

10
src/commands/cluster-getkeysinslot.json
View File

@ -22,6 +22,14 @@
"name": "count",
"type": "integer"
}
]
],
"reply_schema": {
"description": "an array with up to count elements",
"type": "array",
"items": {
"description": "key name",
"type": "string"
}
}
}
}

9
src/commands/cluster-help.json
View File

@ -10,6 +10,13 @@
"command_flags": [
"LOADING",
"STALE"
]
],
"reply_schema": {
"type": "array",
"description": "Helpful text about subcommands.",
"items": {
"type": "string"
}
}
}
}

6
src/commands/cluster-info.json
View File

@ -12,6 +12,10 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
]
],
"reply_schema": {
"description": "A map between named fields and values in the form of <field>:<value> lines separated by newlines composed by the two bytes CRLF",
"type": "string"
}
}
}

7
src/commands/cluster-keyslot.json
View File

@ -15,6 +15,11 @@
"name": "key",
"type": "string"
}
]
],
"reply_schema": {
"description": "The hash slot number for the specified key",
"type": "integer",
"minimum": 0
}
}
}

43
src/commands/cluster-links.json
View File

@ -12,6 +12,49 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"reply_schema": {
"description": "an array of cluster links and their attributes",
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"description": "This link is established by the local node _to_ the peer, or accepted by the local node _from_ the peer.",
"oneOf": [
{
"description": "connection initiated from peer",
"const": "from"
},
{
"description": "connection initiated to peer",
"const": "to"
}
]
},
"node": {
"description": "the node id of the peer",
"type": "string"
},
"create-time": {
"description": "unix time creation time of the link. (In the case of a _to_ link, this is the time when the TCP link is created by the local node, not the time when it is actually established.)",
"type": "integer"
},
"events": {
"description": "events currently registered for the link. r means readable event, w means writable event",
"type": "string"
},
"send-buffer-allocated": {
"description": "allocated size of the link's send buffer, which is used to buffer outgoing messages toward the peer",
"type": "integer"
},
"send-buffer-used": {
"description": "size of the portion of the link's send buffer that is currently holding data(messages)",
"type": "integer"
}
},
"additionalProperties": false
}
}
}
}

5
src/commands/cluster-meet.json
View File

@ -33,6 +33,9 @@
"optional": true,
"since": "4.0.0"
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

6
src/commands/cluster-myid.json
View File

@ -9,6 +9,10 @@
"function": "clusterCommand",
"command_flags": [
"STALE"
]
],
"reply_schema": {
"description": "the node id",
"type": "string"
}
}
}

6
src/commands/cluster-myshardid.json
View File

@ -13,6 +13,10 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
]
],
"reply_schema": {
"description": "the node's shard id",
"type": "string"
}
}
}

6
src/commands/cluster-nodes.json
View File

@ -12,6 +12,10 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
]
],
"reply_schema": {
"description": "the serialized cluster configuration",
"type": "string"
}
}
}

10
src/commands/cluster-replicas.json
View File

@ -19,6 +19,14 @@
"name": "node-id",
"type": "string"
}
]
],
"reply_schema": {
"description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES",
"type": "array",
"items": {
"type": "string",
"description": "the serialized cluster configuration"
}
}
}
}

5
src/commands/cluster-replicate.json
View File

@ -17,6 +17,9 @@
"name": "node-id",
"type": "string"
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-reset.json
View File

@ -30,6 +30,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-saveconfig.json
View File

@ -11,6 +11,9 @@
"NO_ASYNC_LOADING",
"ADMIN",
"STALE"
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-set-config-epoch.json
View File

@ -17,6 +17,9 @@
"name": "config-epoch",
"type": "integer"
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/cluster-setslot.json
View File

@ -46,6 +46,9 @@
}
]
}
]
],
"reply_schema": {
"const": "OK"
}
}
}

71
src/commands/cluster-shards.json
View File

@ -13,6 +13,77 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"reply_schema": {
"description": "a nested list of a map of hash ranges and shard nodes describing individual shards",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slots": {
"description": "an even number element array specifying the start and end slot numbers for slot ranges owned by this shard",
"type": "array",
"items": {
"type": "string"
}
},
"nodes": {
"description": "nodes that handle these slot ranges",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls-port": {
"type": "integer"
},
"ip": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"hostname": {
"type": "string"
},
"role": {
"oneOf": [
{
"const": "master"
},
{
"const": "replica"
}
]
},
"replication-offset": {
"type": "integer"
},
"health": {
"oneOf": [
{
"const": "fail"
},
{
"const": "loading"
},
{
"const": "online"
}
]
}
}
}
}
}
}
}
}
}

10
src/commands/cluster-slaves.json
View File

@ -24,6 +24,14 @@
"name": "node-id",
"type": "string"
}
]
],
"reply_schema": {
"description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES",
"type": "array",
"items": {
"type": "string",
"description": "the serialized cluster configuration"
}
}
}
}

103
src/commands/cluster-slots.json
View File

@ -27,6 +27,109 @@
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"reply_schema": {
"description": "nested list of slot ranges with networking information",
"type": "array",
"items": {
"type": "array",
"minItems": 3,
"maxItems": 4294967295,
"items": [
{
"description": "start slot number",
"type": "integer"
},
{
"description": "end slot number",
"type": "integer"
},
{
"type": "array",
"description": "Master node for the slot range",
"minItems": 4,
"maxItems": 4,
"items": [
{
"description": "endpoint description",
"oneOf": [
{
"description": "hostname or ip",
"type": "string"
},
{
"description": "unknown type",
"type": "null"
}
]
},
{
"description": "port",
"type": "integer"
},
{
"description": "node name",
"type": "string"
},
{
"description": "array of node descriptions",
"type": "object",
"additionalProperties": false,
"properties": {
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
}
}
}
]
}
],
"additionalItems": {
"type": "array",
"description": "Replica node for the slot range",
"minItems": 4,
"maxItems": 4,
"items": [
{
"description": "endpoint description",
"oneOf": [
{
"description": "hostname or ip",
"type": "string"
},
{
"description": "unknown type",
"type": "null"
}
]
},
{
"description": "port",
"type": "integer"
},
{
"description": "node name",
"type": "string"
},
{
"description": "array of node descriptions",
"type": "object",
"additionalProperties": false,
"properties": {
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
}
}
}
]
}
}
}
}
}

6
src/commands/command-count.json
View File

@ -14,6 +14,10 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"description": "Number of total commands in this Redis server.",
"type": "integer"
}
}
}

181
src/commands/command-docs.json
View File

@ -18,6 +18,187 @@
"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",

8
src/commands/command-getkeys.json
View File

@ -15,6 +15,14 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"description": "List of keys from the given Redis command.",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"arguments": [
{
"name": "command",

24
src/commands/command-getkeysandflags.json
View File

@ -15,6 +15,30 @@
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"description": "List of keys from the given Redis command and their usage flags.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"description": "Key name",
"type": "string"
},
{
"description": "Set of key flags",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
]
}
},
"arguments": [
{
"name": "command",

9
src/commands/command-help.json
View File

@ -14,6 +14,13 @@
],
"acl_categories": [
"CONNECTION"
]
],
"reply_schema": {
"type": "array",
"description": "Helpful text about subcommands.",
"items": {
"type": "string"
}
}
}
}

177
src/commands/command-info.json
View File

@ -31,6 +31,183 @@
"optional": true,
"multiple": true
}
],
"reply_schema": {
"type": "array",
"items": {
"oneOf": [
{
"description": "command does not exist",
"type": "null"
},
{
"description": "command info array output",
"type": "array",
"minItems": 10,
"maxItems": 10,
"items": [
{
"description": "command name",
"type": "string"
},
{
"description": "command arity",
"type": "integer"
},
{
"description": "command flags",
"type": "array",
"items": {
"description": "command flag",
"type": "string"
}
},
{
"description": "command first key index",
"type": "integer"
},
{
"description": "command last key index",
"type": "integer"
},
{
"description": "command key step index",
"type": "integer"
},
{
"description": "command categories",
"type": "array",
"items": {
"description": "command category",
"type": "string"
}
},
{
"description": "command tips",
"type": "array",
"items": {
"description": "command tip",
"type": "string"
}
},
{
"description": "command key specs",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"notes": {
"type": "string"
},
"flags": {
"type": "array",
"items": {
"type": "string"
}
},
"begin_search": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"spec": {
"anyOf": [
{
"description": "unknown type, empty map",
"type": "object",
"additionalProperties": false
},
{
"description": "index type",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"type": "integer"
}
}
},
{
"description": "keyword type",
"type": "object",
"additionalProperties": false,
"properties": {
"keyword": {
"type": "string"
},
"startfrom": {
"type": "integer"
}
}
}
]
}
}
},
"find_keys": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"spec": {
"anyOf": [
{
"description": "unknown type",
"type": "object",
"additionalProperties": false
},
{
"description": "range type",
"type": "object",
"additionalProperties": false,
"properties": {
"lastkey": {
"type": "integer"
},
"keystep": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
{
"description": "keynum type",
"type": "object",
"additionalProperties": false,
"properties": {
"keynumidx": {
"type": "integer"
},
"firstkey": {
"type": "integer"
},
"keystep": {
"type": "integer"
}
}
}
]
}
}
}
}
}
},
{
"type": "array",
"description": "subcommands"
}
]
}
]
}
}
}
}

10
src/commands/command-list.json
View File

@ -42,6 +42,14 @@
}
]
}
]
],
"reply_schema": {
"type": "array",
"items": {
"description": "command name",
"type": "string"
},
"uniqueItems": true
}
}
}

6
src/commands/config-get.json
View File

@ -19,6 +19,12 @@
"LOADING",
"STALE"
],
"reply_schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"arguments": [
{
"name": "parameter",

9
src/commands/config-help.json
View File

@ -10,6 +10,13 @@
"command_flags": [
"LOADING",
"STALE"
]
],
"reply_schema": {
"type": "array",
"description": "Helpful text about subcommands.",
"items": {
"type": "string"
}
}
}
}

5
src/commands/config-resetstat.json
View File

@ -12,6 +12,9 @@
"NOSCRIPT",
"LOADING",
"STALE"
]
],
"reply_schema": {
"const": "OK"
}
}
}

5
src/commands/config-rewrite.json
View File

@ -12,6 +12,9 @@
"NOSCRIPT",
"LOADING",
"STALE"
]
],
"reply_schema": {
"const": "OK"
}
}
}

3
src/commands/config-set.json
View File

@ -23,6 +23,9 @@
"REQUEST_POLICY:ALL_NODES",
"RESPONSE_POLICY:ALL_SUCCEEDED"
],
"reply_schema": {
"const": "OK"
},
"arguments": [
{
"name": "data",

12
src/commands/copy.json
View File

@ -74,6 +74,18 @@
"type": "pure-token",
"optional": true
}
],
"reply_schema": {
"oneOf": [
{
"description": "source was copied",
"const": 1
},
{
"description": "source was not copied",
"const": 0
}
]
}
}
}

6
src/commands/dbsize.json
View File

@ -16,6 +16,10 @@
"command_tips": [
"REQUEST_POLICY:ALL_SHARDS",
"RESPONSE_POLICY:AGG_SUM"
]
],
"reply_schema": {
"type": "integer",
"description": "The number of keys in the currently-selected database."
}
}
}

4
src/commands/decr.json
View File

@ -35,6 +35,10 @@
}
}
],
"reply_schema": {
"type": "integer",
"description": "The value of the key after decrementing it."
},
"arguments": [
{
"name": "key",

4
src/commands/decrby.json
View File

@ -35,6 +35,10 @@
}
}
],
"reply_schema": {
"type": "integer",
"description": "The value of the key after decrementing it."
},
"arguments": [
{
"name": "key",

5
src/commands/del.json
View File

@ -36,6 +36,11 @@
}
}
],
"reply_schema": {
"description": "the number of keys that were removed",
"type": "integer",
"minimum": 0
},
"arguments": [
{
"name": "key",

5
src/commands/discard.json
View File

@ -15,6 +15,9 @@
],
"acl_categories": [
"TRANSACTION"
]
],
"reply_schema": {
"const": "OK"
}
}
}

12
src/commands/dump.json
View File

@ -35,6 +35,18 @@
}
}
],
"reply_schema": {
"oneOf": [
{
"description": "The serialized value.",
"type": "string"
},
{
"description": "Key does not exist.",
"type": "null"
}
]
},
"arguments": [
{
"name": "key",

Some files were not shown because too many files have changed in this diff Show More