-
Notifications
You must be signed in to change notification settings - Fork 674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Untrademark json files #26
Changes from all commits
34102e3
f1790f9
65af786
ccbdf60
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -32,7 +32,7 @@ | |||||
"type": "string" | ||||||
}, | ||||||
"since": { | ||||||
"description": "the Redis version that added the command (or for module commands, the module version).", | ||||||
"description": "the server verion that added the command (or for module commands, the module version).", | ||||||
"type": "string" | ||||||
}, | ||||||
"group": { | ||||||
|
@@ -118,7 +118,7 @@ | |||||
} | ||||||
}, | ||||||
"deprecated_since": { | ||||||
"description": "the Redis version that deprecated the command (or for module commands, the module version)", | ||||||
"description": "the server verion that deprecated the command (or for module commands, the module version)", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
"type": "string" | ||||||
}, | ||||||
"replaced_by": { | ||||||
|
@@ -135,7 +135,7 @@ | |||||
"items": [ | ||||||
{ | ||||||
"type": "string", | ||||||
"description": "The Redis version that the entry applies to." | ||||||
"description": "The server verion that the entry applies to." | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
}, | ||||||
{ | ||||||
"type": "string", | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,6 +1,6 @@ | ||||||
{ | ||||||
"LOLWUT": { | ||||||
"summary": "Displays computer art and the Redis version", | ||||||
"summary": "Displays computer art and the server verion", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
"group": "server", | ||||||
"since": "5.0.0", | ||||||
"arity": -1, | ||||||
|
@@ -11,7 +11,7 @@ | |||||
], | ||||||
"reply_schema": { | ||||||
"type": "string", | ||||||
"description": "String containing the generative computer art, and a text with the Redis version." | ||||||
"description": "String containing the generative computer art, and a text with the server verion." | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
}, | ||||||
"arguments": [ | ||||||
{ | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I misspelled in the mass replace. 😪