-
Notifications
You must be signed in to change notification settings - Fork 672
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove "Redis" in src/commands/README.md
- Loading branch information
1 parent
65af786
commit ccbdf60
Showing
1 changed file
with
2 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,13 @@ | ||
This directory contains JSON files, one for each of Redis commands. | ||
This directory contains JSON files, one for each command. | ||
|
||
Each JSON contains all the information about the command itself, but these JSON files are not to be used directly! | ||
Any third party who needs access to command information must get it from `COMMAND INFO` and `COMMAND DOCS`. | ||
The output can be extracted in a JSON format by using `redis-cli --json`, in the same manner as in `utils/generate-commands-json.py`. | ||
|
||
The JSON files are used to generate commands.def (and https://github.com/redis/redis-doc/blob/master/commands.json) in Redis, and | ||
The JSON files are used to generate commands.def within this repo and JSON files for documentation, and | ||
despite looking similar to the output of `COMMAND` there are some fields and flags that are implicitly populated, and that's the | ||
reason one shouldn't rely on the raw files. | ||
|
||
The structure of each JSON is somewhat documented in https://redis.io/commands/command-docs/ and https://redis.io/commands/command/ | ||
|
||
The `reply_schema` section is a standard JSON Schema (see https://json-schema.org/) that describes the reply of each command. | ||
It is designed to someday be used to auto-generate code in client libraries, but is not yet mature and is not exposed externally. | ||
|