From ccbdf608f051b6c253aad512966024c402465212 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20S=C3=B6derqvist?= Date: Mon, 25 Mar 2024 18:44:04 +0100 Subject: [PATCH] Remove "Redis" in src/commands/README.md --- src/commands/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/commands/README.md b/src/commands/README.md index 5ef9a3f290..0a4d730f1b 100644 --- a/src/commands/README.md +++ b/src/commands/README.md @@ -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.