From 42e00635af0717b79a6d214889fe2cdd883928d4 Mon Sep 17 00:00:00 2001 From: pragnesh Date: Tue, 2 Apr 2024 22:45:23 +0530 Subject: [PATCH] Fix inconsistencies in the json command file descriptions (#63) Grammar. Use full sentences. Signed-off-by: Pragnesh --- src/commands/acl-cat.json | 2 +- src/commands/acl-deluser.json | 2 +- src/commands/acl-getuser.json | 8 +- src/commands/acl-help.json | 2 +- src/commands/acl-list.json | 2 +- src/commands/acl-users.json | 2 +- src/commands/bitop.json | 2 +- src/commands/bitpos.json | 4 +- src/commands/client-info.json | 2 +- src/commands/client-kill.json | 4 +- src/commands/client-tracking.json | 2 +- src/commands/client-unblock.json | 4 +- src/commands/cluster-bumpepoch.json | 4 +- .../cluster-count-failure-reports.json | 2 +- src/commands/cluster-countkeysinslot.json | 2 +- src/commands/cluster-getkeysinslot.json | 4 +- src/commands/cluster-links.json | 16 ++-- src/commands/cluster-myid.json | 2 +- src/commands/cluster-myshardid.json | 2 +- src/commands/cluster-nodes.json | 2 +- src/commands/cluster-replicas.json | 4 +- src/commands/cluster-shards.json | 6 +- src/commands/cluster-slaves.json | 4 +- src/commands/cluster-slots.json | 34 ++++---- src/commands/command-docs.json | 26 +++--- src/commands/command-info.json | 42 +++++----- src/commands/command-list.json | 2 +- src/commands/copy.json | 4 +- src/commands/del.json | 2 +- src/commands/function-dump.json | 2 +- src/commands/function-list.json | 14 ++-- src/commands/function-stats.json | 18 ++-- src/commands/geodist.json | 4 +- src/commands/georadius.json | 20 ++--- src/commands/georadius_ro.json | 18 ++-- src/commands/georadiusbymember.json | 20 ++--- src/commands/georadiusbymember_ro.json | 18 ++-- src/commands/geosearch.json | 18 ++-- src/commands/geosearchstore.json | 2 +- src/commands/hscan.json | 6 +- src/commands/keys.json | 2 +- src/commands/latency-history.json | 4 +- src/commands/linsert.json | 4 +- src/commands/lpushx.json | 2 +- src/commands/memory-doctor.json | 2 +- src/commands/memory-stats.json | 2 +- src/commands/move.json | 4 +- src/commands/object-encoding.json | 4 +- src/commands/object-freq.json | 2 +- src/commands/object-idletime.json | 2 +- src/commands/object-refcount.json | 2 +- src/commands/pfadd.json | 4 +- src/commands/publish.json | 2 +- src/commands/pubsub-channels.json | 2 +- src/commands/pubsub-numpat.json | 2 +- src/commands/pubsub-numsub.json | 2 +- src/commands/pubsub-shardchannels.json | 2 +- src/commands/pubsub-shardnumsub.json | 2 +- src/commands/randomkey.json | 4 +- src/commands/renamenx.json | 4 +- src/commands/replicaof.json | 2 +- src/commands/role.json | 34 ++++---- src/commands/scan.json | 6 +- src/commands/script-exists.json | 4 +- src/commands/slaveof.json | 2 +- src/commands/sort.json | 6 +- src/commands/sort_ro.json | 4 +- src/commands/spublish.json | 2 +- src/commands/sscan.json | 6 +- src/commands/touch.json | 2 +- src/commands/unlink.json | 2 +- src/commands/xclaim.json | 10 +-- src/commands/xinfo-stream.json | 84 +++++++++---------- src/commands/xread.json | 10 +-- src/commands/zrangebyscore.json | 12 +-- src/commands/zrevrange.json | 4 +- src/commands/zrevrangebyscore.json | 12 +-- src/commands/zscan.json | 6 +- 78 files changed, 298 insertions(+), 298 deletions(-) diff --git a/src/commands/acl-cat.json b/src/commands/acl-cat.json index dfbe4c43ef..cf86106773 100644 --- a/src/commands/acl-cat.json +++ b/src/commands/acl-cat.json @@ -24,7 +24,7 @@ }, { "type": "array", - "description": "In case `category` was given, list of commands that fall under the provided ACL category", + "description": "In case `category` was given, list of commands that fall under the provided ACL category.", "items": { "type": "string" } diff --git a/src/commands/acl-deluser.json b/src/commands/acl-deluser.json index 80e8a7ad51..d300f88cec 100644 --- a/src/commands/acl-deluser.json +++ b/src/commands/acl-deluser.json @@ -20,7 +20,7 @@ ], "reply_schema": { "type": "integer", - "description": "The number of users that were deleted" + "description": "The number of users that were deleted." }, "arguments": [ { diff --git a/src/commands/acl-getuser.json b/src/commands/acl-getuser.json index 535389bc53..cedd35f5cc 100644 --- a/src/commands/acl-getuser.json +++ b/src/commands/acl-getuser.json @@ -33,7 +33,7 @@ "reply_schema": { "oneOf": [ { - "description": "a set of ACL rule definitions for the user", + "description": "A set of ACL rule definitions for the user.", "type": "object", "additionalProperties": false, "properties": { @@ -50,15 +50,15 @@ } }, "commands": { - "description": "root selector's commands", + "description": "Root selector's commands.", "type": "string" }, "keys": { - "description": "root selector's keys", + "description": "Root selector's keys.", "type": "string" }, "channels": { - "description": "root selector's channels", + "description": "Root selector's channels.", "type": "string" }, "selectors": { diff --git a/src/commands/acl-help.json b/src/commands/acl-help.json index 3c95914dbd..e31024327f 100644 --- a/src/commands/acl-help.json +++ b/src/commands/acl-help.json @@ -14,7 +14,7 @@ ], "reply_schema": { "type": "array", - "description": "A list of subcommands and their description", + "description": "A list of subcommands and their description.", "items": { "type": "string" } diff --git a/src/commands/acl-list.json b/src/commands/acl-list.json index 0d75b137f3..415cdf59b7 100644 --- a/src/commands/acl-list.json +++ b/src/commands/acl-list.json @@ -16,7 +16,7 @@ ], "reply_schema": { "type": "array", - "description": "A list of currently active ACL rules", + "description": "A list of currently active ACL rules.", "items": { "type": "string" } diff --git a/src/commands/acl-users.json b/src/commands/acl-users.json index 1a6bc75579..98ab53d0d3 100644 --- a/src/commands/acl-users.json +++ b/src/commands/acl-users.json @@ -16,7 +16,7 @@ ], "reply_schema": { "type": "array", - "description": "List of existing ACL users", + "description": "List of existing ACL users.", "items": { "type": "string" } diff --git a/src/commands/bitop.json b/src/commands/bitop.json index d9e1ff9ef7..8d60cffa59 100644 --- a/src/commands/bitop.json +++ b/src/commands/bitop.json @@ -91,7 +91,7 @@ } ], "reply_schema": { - "description": "the size of the string stored in the destination key, that is equal to the size of the longest input string", + "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 } diff --git a/src/commands/bitpos.json b/src/commands/bitpos.json index 11b0851e85..b0834dd5dc 100644 --- a/src/commands/bitpos.json +++ b/src/commands/bitpos.json @@ -92,12 +92,12 @@ "reply_schema": { "oneOf": [ { - "description": "the position of the first bit set to 1 or 0 according to the request", + "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", + "description": "In case the `bit` argument is 1 and the string is empty or composed of just zero bytes.", "const": -1 } ] diff --git a/src/commands/client-info.json b/src/commands/client-info.json index 93fa008f52..f974da437b 100644 --- a/src/commands/client-info.json +++ b/src/commands/client-info.json @@ -20,7 +20,7 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "a unique string, as described at the CLIENT LIST page, for the current client", + "description": "A unique string, as described at the CLIENT LIST page, for the current client.", "type": "string" } } diff --git a/src/commands/client-kill.json b/src/commands/client-kill.json index 7efd805081..01079ad993 100644 --- a/src/commands/client-kill.json +++ b/src/commands/client-kill.json @@ -156,11 +156,11 @@ "reply_schema": { "oneOf": [ { - "description": "when called in 3 argument format", + "description": "When called in 3 argument format.", "const": "OK" }, { - "description": "when called in filter/value format, the number of clients killed", + "description": "When called in filter/value format, the number of clients killed.", "type": "integer", "minimum": 0 } diff --git a/src/commands/client-tracking.json b/src/commands/client-tracking.json index 28e84eceb1..2c3768c2fb 100644 --- a/src/commands/client-tracking.json +++ b/src/commands/client-tracking.json @@ -73,7 +73,7 @@ } ], "reply_schema": { - "description": "if the client was successfully put into or taken out of tracking mode", + "description": "If the client was successfully put into or taken out of tracking mode.", "const": "OK" } } diff --git a/src/commands/client-unblock.json b/src/commands/client-unblock.json index d028f47149..d391ede9e9 100644 --- a/src/commands/client-unblock.json +++ b/src/commands/client-unblock.json @@ -21,11 +21,11 @@ "oneOf": [ { "const": 0, - "description": "if the client was unblocked successfully" + "description": "If the client was unblocked successfully." }, { "const": 1, - "description": "if the client wasn't unblocked" + "description": "If the client wasn't unblocked." } ] }, diff --git a/src/commands/cluster-bumpepoch.json b/src/commands/cluster-bumpepoch.json index 786723c5c2..03a8370334 100644 --- a/src/commands/cluster-bumpepoch.json +++ b/src/commands/cluster-bumpepoch.json @@ -18,12 +18,12 @@ "reply_schema": { "oneOf": [ { - "description": "if the epoch was incremented", + "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", + "description": "If the node already has the greatest config epoch in the cluster.", "type": "string", "pattern": "^STILL [0-9]*$" } diff --git a/src/commands/cluster-count-failure-reports.json b/src/commands/cluster-count-failure-reports.json index b80632d0fa..ad185dafc6 100644 --- a/src/commands/cluster-count-failure-reports.json +++ b/src/commands/cluster-count-failure-reports.json @@ -21,7 +21,7 @@ } ], "reply_schema": { - "description": "the number of active failure reports for the node", + "description": "The number of active failure reports for the node.", "type": "integer", "minimum": 0 } diff --git a/src/commands/cluster-countkeysinslot.json b/src/commands/cluster-countkeysinslot.json index caeec51320..e270990b15 100644 --- a/src/commands/cluster-countkeysinslot.json +++ b/src/commands/cluster-countkeysinslot.json @@ -17,7 +17,7 @@ } ], "reply_schema": { - "description": "The number of keys in the specified hash slot", + "description": "The number of keys in the specified hash slot.", "type": "integer", "minimum": 0 } diff --git a/src/commands/cluster-getkeysinslot.json b/src/commands/cluster-getkeysinslot.json index 039dfeabf6..6444a761fd 100644 --- a/src/commands/cluster-getkeysinslot.json +++ b/src/commands/cluster-getkeysinslot.json @@ -24,10 +24,10 @@ } ], "reply_schema": { - "description": "an array with up to count elements", + "description": "An array with up to count elements.", "type": "array", "items": { - "description": "key name", + "description": "Key name.", "type": "string" } } diff --git a/src/commands/cluster-links.json b/src/commands/cluster-links.json index 07b2e833b3..6f81e1a9e6 100644 --- a/src/commands/cluster-links.json +++ b/src/commands/cluster-links.json @@ -14,7 +14,7 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "an array of cluster links and their attributes", + "description": "An array of cluster links and their attributes.", "type": "array", "items": { "type": "object", @@ -23,33 +23,33 @@ "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", + "description": "Connection initiated from peer.", "const": "from" }, { - "description": "connection initiated to peer", + "description": "Connection initiated to peer.", "const": "to" } ] }, "node": { - "description": "the node id of the peer", + "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.)", + "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", + "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", + "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)", + "description": "Size of the portion of the link's send buffer that is currently holding data(messages).", "type": "integer" } }, diff --git a/src/commands/cluster-myid.json b/src/commands/cluster-myid.json index 340d425fd3..caa62de756 100644 --- a/src/commands/cluster-myid.json +++ b/src/commands/cluster-myid.json @@ -11,7 +11,7 @@ "STALE" ], "reply_schema": { - "description": "the node id", + "description": "The node id.", "type": "string" } } diff --git a/src/commands/cluster-myshardid.json b/src/commands/cluster-myshardid.json index 7db63fd190..88a7107309 100644 --- a/src/commands/cluster-myshardid.json +++ b/src/commands/cluster-myshardid.json @@ -15,7 +15,7 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "the node's shard id", + "description": "The node's shard id.", "type": "string" } } diff --git a/src/commands/cluster-nodes.json b/src/commands/cluster-nodes.json index ce34944e19..9c5fcbe9a4 100644 --- a/src/commands/cluster-nodes.json +++ b/src/commands/cluster-nodes.json @@ -14,7 +14,7 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "the serialized cluster configuration", + "description": "The serialized cluster configuration.", "type": "string" } } diff --git a/src/commands/cluster-replicas.json b/src/commands/cluster-replicas.json index e01617feeb..4e8bd4204c 100644 --- a/src/commands/cluster-replicas.json +++ b/src/commands/cluster-replicas.json @@ -21,11 +21,11 @@ } ], "reply_schema": { - "description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES", + "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" + "description": "The serialized cluster configuration." } } } diff --git a/src/commands/cluster-shards.json b/src/commands/cluster-shards.json index e7a0829534..472e957ea5 100644 --- a/src/commands/cluster-shards.json +++ b/src/commands/cluster-shards.json @@ -16,21 +16,21 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "a nested list of a map of hash ranges and shard nodes describing individual shards", + "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", + "description": "An even number element array specifying the start and end slot numbers for slot ranges owned by this shard.", "type": "array", "items": { "type": "integer" } }, "nodes": { - "description": "nodes that handle these slot ranges", + "description": "Nodes that handle these slot ranges.", "type": "array", "items": { "type": "object", diff --git a/src/commands/cluster-slaves.json b/src/commands/cluster-slaves.json index a736088e4c..db66a1c1db 100644 --- a/src/commands/cluster-slaves.json +++ b/src/commands/cluster-slaves.json @@ -26,11 +26,11 @@ } ], "reply_schema": { - "description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES", + "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" + "description": "The serialized cluster configuration." } } } diff --git a/src/commands/cluster-slots.json b/src/commands/cluster-slots.json index b00cc60f47..13f8c26612 100644 --- a/src/commands/cluster-slots.json +++ b/src/commands/cluster-slots.json @@ -30,7 +30,7 @@ "NONDETERMINISTIC_OUTPUT" ], "reply_schema": { - "description": "nested list of slot ranges with networking information", + "description": "Nested list of slot ranges with networking information.", "type": "array", "items": { "type": "array", @@ -38,42 +38,42 @@ "maxItems": 4294967295, "items": [ { - "description": "start slot number", + "description": "Start slot number.", "type": "integer" }, { - "description": "end slot number", + "description": "End slot number.", "type": "integer" }, { "type": "array", - "description": "Master node for the slot range", + "description": "Master node for the slot range.", "minItems": 4, "maxItems": 4, "items": [ { - "description": "endpoint description", + "description": "Endpoint description.", "oneOf": [ { - "description": "hostname or ip", + "description": "Hostname or ip.", "type": "string" }, { - "description": "unknown type", + "description": "Unknown type.", "type": "null" } ] }, { - "description": "port", + "description": "Port.", "type": "integer" }, { - "description": "node name", + "description": "Node name.", "type": "string" }, { - "description": "array of node descriptions", + "description": "Array of node descriptions.", "type": "object", "additionalProperties": false, "properties": { @@ -90,33 +90,33 @@ ], "additionalItems": { "type": "array", - "description": "Replica node for the slot range", + "description": "Replica node for the slot range.", "minItems": 4, "maxItems": 4, "items": [ { - "description": "endpoint description", + "description": "Endpoint description.", "oneOf": [ { - "description": "hostname or ip", + "description": "Hostname or ip.", "type": "string" }, { - "description": "unknown type", + "description": "Unknown type.", "type": "null" } ] }, { - "description": "port", + "description": "Port.", "type": "integer" }, { - "description": "node name", + "description": "Node name.", "type": "string" }, { - "description": "array of node descriptions", + "description": "Array of node descriptions.", "type": "object", "additionalProperties": false, "properties": { diff --git a/src/commands/command-docs.json b/src/commands/command-docs.json index ea575b0437..60a7ee423f 100644 --- a/src/commands/command-docs.json +++ b/src/commands/command-docs.json @@ -28,15 +28,15 @@ "additionalProperties": false, "properties": { "summary": { - "description": "short command description", + "description": "Short command description.", "type": "string" }, "since": { - "description": "the server version that added the command (or for module commands, the module version).", + "description": "The server version that added the command (or for module commands, the module version).", "type": "string" }, "group": { - "description": "the functional group to which the command belongs", + "description": "The functional group to which the command belongs.", "oneOf": [ { "const": "bitmap" @@ -95,38 +95,38 @@ ] }, "complexity": { - "description": "a short explanation about the command's time complexity.", + "description": "A short explanation about the command's time complexity.", "type": "string" }, "module": { "type": "string" }, "doc_flags": { - "description": "an array of documentation flags", + "description": "An array of documentation flags.", "type": "array", "items": { "oneOf": [ { - "description": "the command is deprecated.", + "description": "The command is deprecated.", "const": "deprecated" }, { - "description": "a system command that isn't meant to be called by users.", + "description": "A system command that isn't meant to be called by users.", "const": "syscmd" } ] } }, "deprecated_since": { - "description": "the server version that deprecated the command (or for module commands, the module version)", + "description": "The server version that deprecated the command (or for module commands, the module version).", "type": "string" }, "replaced_by": { - "description": "the alternative for a deprecated command.", + "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.", + "description": "An array of historical notes describing changes to the command's behavior or arguments.", "type": "array", "items": { "type": "array", @@ -145,7 +145,7 @@ } }, "arguments": { - "description": "an array of maps that describe the command's arguments.", + "description": "An array of maps that describe the command's arguments.", "type": "array", "items": { "type": "object", @@ -188,11 +188,11 @@ } }, "reply_schema": { - "description": "command 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", + "description": "A map where each key is a subcommand, and each value is the documentary information.", "$ref": "#" } } diff --git a/src/commands/command-info.json b/src/commands/command-info.json index 8c69060959..d37d140e1e 100644 --- a/src/commands/command-info.json +++ b/src/commands/command-info.json @@ -37,61 +37,61 @@ "items": { "oneOf": [ { - "description": "command does not exist", + "description": "Command does not exist.", "type": "null" }, { - "description": "command info array output", + "description": "Command info array output.", "type": "array", "minItems": 10, "maxItems": 10, "items": [ { - "description": "command name", + "description": "Command name.", "type": "string" }, { - "description": "command arity", + "description": "Command arity.", "type": "integer" }, { - "description": "command flags", + "description": "Command flags.", "type": "array", "items": { - "description": "command flag", + "description": "Command flag.", "type": "string" } }, { - "description": "command first key index", + "description": "Command first key index.", "type": "integer" }, { - "description": "command last key index", + "description": "Command last key index.", "type": "integer" }, { - "description": "command key step index", + "description": "Command key step index.", "type": "integer" }, { - "description": "command categories", + "description": "Command categories.", "type": "array", "items": { - "description": "command category", + "description": "Command category.", "type": "string" } }, { - "description": "command tips", + "description": "Command tips.", "type": "array", "items": { - "description": "command tip", + "description": "Command tip.", "type": "string" } }, { - "description": "command key specs", + "description": "Command key specs.", "type": "array", "items": { "type": "object", @@ -116,12 +116,12 @@ "spec": { "anyOf": [ { - "description": "unknown type, empty map", + "description": "Unknown type, empty map.", "type": "object", "additionalProperties": false }, { - "description": "index type", + "description": "Index type.", "type": "object", "additionalProperties": false, "properties": { @@ -131,7 +131,7 @@ } }, { - "description": "keyword type", + "description": "Keyword type.", "type": "object", "additionalProperties": false, "properties": { @@ -157,12 +157,12 @@ "spec": { "anyOf": [ { - "description": "unknown type", + "description": "Unknown type.", "type": "object", "additionalProperties": false }, { - "description": "range type", + "description": "Range type.", "type": "object", "additionalProperties": false, "properties": { @@ -178,7 +178,7 @@ } }, { - "description": "keynum type", + "description": "Keynum type.", "type": "object", "additionalProperties": false, "properties": { @@ -202,7 +202,7 @@ }, { "type": "array", - "description": "subcommands" + "description": "Subcommands." } ] } diff --git a/src/commands/command-list.json b/src/commands/command-list.json index 7f4e3f5da0..e050968517 100644 --- a/src/commands/command-list.json +++ b/src/commands/command-list.json @@ -46,7 +46,7 @@ "reply_schema": { "type": "array", "items": { - "description": "command name", + "description": "Command name.", "type": "string" }, "uniqueItems": true diff --git a/src/commands/copy.json b/src/commands/copy.json index b30ddaeae7..7774782f45 100644 --- a/src/commands/copy.json +++ b/src/commands/copy.json @@ -78,11 +78,11 @@ "reply_schema": { "oneOf": [ { - "description": "source was copied", + "description": "Source was copied.", "const": 1 }, { - "description": "source was not copied", + "description": "Source was not copied.", "const": 0 } ] diff --git a/src/commands/del.json b/src/commands/del.json index 2727b536c2..c8c7524f5f 100644 --- a/src/commands/del.json +++ b/src/commands/del.json @@ -37,7 +37,7 @@ } ], "reply_schema": { - "description": "the number of keys that were removed", + "description": "The number of keys that were removed.", "type": "integer", "minimum": 0 }, diff --git a/src/commands/function-dump.json b/src/commands/function-dump.json index d117241de3..da95fcd2fb 100644 --- a/src/commands/function-dump.json +++ b/src/commands/function-dump.json @@ -14,7 +14,7 @@ "SCRIPTING" ], "reply_schema": { - "description": "the serialized payload", + "description": "The serialized payload.", "type": "string" } } diff --git a/src/commands/function-list.json b/src/commands/function-list.json index 2ab1cf510c..d34176bca6 100644 --- a/src/commands/function-list.json +++ b/src/commands/function-list.json @@ -23,26 +23,26 @@ "additionalProperties": false, "properties": { "library_name": { - "description": " the name of the library", + "description": "The name of the library.", "type": "string" }, "engine": { - "description": "the engine of the library", + "description": "The engine of the library.", "type": "string" }, "functions": { - "description": "the list of functions in the library", + "description": "The list of functions in the library.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { - "description": "the name of the function", + "description": "The name of the function.", "type": "string" }, "description": { - "description": "the function's description", + "description": "The function's description.", "oneOf": [ { "type": "null" @@ -53,7 +53,7 @@ ] }, "flags": { - "description": "an array of function flags", + "description": "An array of function flags.", "type": "array", "items": { "type": "string" @@ -63,7 +63,7 @@ } }, "library_code": { - "description": "the library's source code (when given the WITHCODE modifier)", + "description": "The library's source code (when given the WITHCODE modifier).", "type": "string" } } diff --git a/src/commands/function-stats.json b/src/commands/function-stats.json index 65519db1c3..42a3c032eb 100644 --- a/src/commands/function-stats.json +++ b/src/commands/function-stats.json @@ -24,30 +24,30 @@ "additionalProperties": false, "properties": { "running_script": { - "description": "information about the running script.", + "description": "Information about the running script.", "oneOf": [ { - "description": "If there's no in-flight function", + "description": "If there's no in-flight function.", "type": "null" }, { - "description": "a map with the information about the running script", + "description": "A map with the information about the running script.", "type": "object", "additionalProperties": false, "properties": { "name": { - "description": "the name of the function.", + "description": "The name of the function.", "type": "string" }, "command": { - "description": "the command and arguments used for invoking the function.", + "description": "The command and arguments used for invoking the function.", "type": "array", "items": { "type": "string" } }, "duration_ms": { - "description": "the function's runtime duration in milliseconds.", + "description": "The function's runtime duration in milliseconds.", "type": "integer" } } @@ -59,16 +59,16 @@ "type": "object", "patternProperties": { "^.*$": { - "description": "Engine map contains statistics about the engine", + "description": "Engine map contains statistics about the engine.", "type": "object", "additionalProperties": false, "properties": { "libraries_count": { - "description": "number of libraries", + "description": "Number of libraries.", "type": "integer" }, "functions_count": { - "description": "number of functions", + "description": "Number of functions.", "type": "integer" } } diff --git a/src/commands/geodist.json b/src/commands/geodist.json index 145ca718a8..b49705d0cd 100644 --- a/src/commands/geodist.json +++ b/src/commands/geodist.json @@ -77,11 +77,11 @@ "reply_schema": { "oneOf": [ { - "description": "one or both of elements are missing", + "description": "One or both of elements are missing.", "type": "null" }, { - "description": "distance as a double (represented as a string) in the specified units", + "description": "Distance as a double (represented as a string) in the specified units.", "type": "string", "pattern": "^[0-9]*(.[0-9]*)?$" } diff --git a/src/commands/georadius.json b/src/commands/georadius.json index 6ced9049ce..2e01b2b3d8 100644 --- a/src/commands/georadius.json +++ b/src/commands/georadius.json @@ -208,13 +208,13 @@ } ], "reply_schema": { - "description": "Array of matched members information", + "description": "Array of matched members information.", "anyOf": [ { - "description": "If no WITH* option is specified, array of matched members names", + "description": "If no WITH* option is specified, array of matched members names.", "type": "array", "items": { - "description": "name", + "description": "Name.", "type": "string" } }, @@ -226,32 +226,32 @@ "maxItems": 4, "items": [ { - "description": "Matched member name", + "description": "Matched member name.", "type": "string" } ], "additionalItems": { "oneOf": [ { - "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius", + "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius.", "type": "string" }, { - "description": "If WITHHASH option is specified, the geohash integer", + "description": "If WITHHASH option is specified, the geohash integer.", "type": "integer" }, { - "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude)", + "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude).", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "latitude (x)", + "description": "Latitude (x).", "type": "number" }, { - "description": "longitude (y)", + "description": "Longitude (y).", "type": "number" } ] @@ -261,7 +261,7 @@ } }, { - "description": "number of items stored in key", + "description": "Number of items stored in key.", "type": "integer" } ] diff --git a/src/commands/georadius_ro.json b/src/commands/georadius_ro.json index b3d335d4a1..ac6dcba510 100644 --- a/src/commands/georadius_ro.json +++ b/src/commands/georadius_ro.json @@ -147,13 +147,13 @@ } ], "reply_schema": { - "description": "Array of matched members information", + "description": "Array of matched members information.", "anyOf": [ { - "description": "If no WITH* option is specified, array of matched members names", + "description": "If no WITH* option is specified, array of matched members names.", "type": "array", "items": { - "description": "name", + "description": "Name.", "type": "string" } }, @@ -165,32 +165,32 @@ "maxItems": 4, "items": [ { - "description": "Matched member name", + "description": "Matched member name.", "type": "string" } ], "additionalItems": { "oneOf": [ { - "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius", + "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius.", "type": "string" }, { - "description": "If WITHHASH option is specified, the geohash integer", + "description": "If WITHHASH option is specified, the geohash integer.", "type": "integer" }, { - "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude)", + "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude).", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "latitude (x)", + "description": "Latitude (x).", "type": "number" }, { - "description": "longitude (y)", + "description": "Longitude (y).", "type": "number" } ] diff --git a/src/commands/georadiusbymember.json b/src/commands/georadiusbymember.json index 6102a1b163..7600b4da39 100644 --- a/src/commands/georadiusbymember.json +++ b/src/commands/georadiusbymember.json @@ -203,13 +203,13 @@ } ], "reply_schema": { - "description": "Array of matched members information", + "description": "Array of matched members information.", "anyOf": [ { - "description": "If no WITH* option is specified, array of matched members names", + "description": "If no WITH* option is specified, array of matched members names.", "type": "array", "items": { - "description": "name", + "description": "Name", "type": "string" } }, @@ -221,32 +221,32 @@ "maxItems": 4, "items": [ { - "description": "Matched member name", + "description": "Matched member name.", "type": "string" } ], "additionalItems": { "oneOf": [ { - "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius", + "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius.", "type": "string" }, { - "description": "If WITHHASH option is specified, the geohash integer", + "description": "If WITHHASH option is specified, the geohash integer.", "type": "integer" }, { - "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude)", + "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude).", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "latitude (x)", + "description": "Latitude (x).", "type": "number" }, { - "description": "longitude (y)", + "description": "Longitude (y).", "type": "number" } ] @@ -256,7 +256,7 @@ } }, { - "description": "number of items stored in key", + "description": "Number of items stored in key.", "type": "integer" } ] diff --git a/src/commands/georadiusbymember_ro.json b/src/commands/georadiusbymember_ro.json index 0cc599feff..ea4f94bddb 100644 --- a/src/commands/georadiusbymember_ro.json +++ b/src/commands/georadiusbymember_ro.json @@ -142,13 +142,13 @@ } ], "reply_schema": { - "description": "Array of matched members information", + "description": "Array of matched members information.", "anyOf": [ { - "description": "If no WITH* option is specified, array of matched members names", + "description": "If no WITH* option is specified, array of matched members names.", "type": "array", "items": { - "description": "name", + "description": "Name.", "type": "string" } }, @@ -160,32 +160,32 @@ "maxItems": 4, "items": [ { - "description": "Matched member name", + "description": "Matched member name.", "type": "string" } ], "additionalItems": { "oneOf": [ { - "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius", + "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius.", "type": "string" }, { - "description": "If WITHHASH option is specified, the geohash integer", + "description": "If WITHHASH option is specified, the geohash integer.", "type": "integer" }, { - "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude)", + "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude).", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "latitude (x)", + "description": "Latitude (x).", "type": "number" }, { - "description": "longitude (y)", + "description": "Longitude (y).", "type": "number" } ] diff --git a/src/commands/geosearch.json b/src/commands/geosearch.json index b2e2825d96..2214c4a8a6 100644 --- a/src/commands/geosearch.json +++ b/src/commands/geosearch.json @@ -209,13 +209,13 @@ } ], "reply_schema": { - "description": "Array of matched members information", + "description": "Array of matched members information.", "anyOf": [ { - "description": "If no WITH* option is specified, array of matched members names", + "description": "If no WITH* option is specified, array of matched members names.", "type": "array", "items": { - "description": "name", + "description": "Name.", "type": "string" } }, @@ -227,32 +227,32 @@ "maxItems": 4, "items": [ { - "description": "Matched member name", + "description": "Matched member name.", "type": "string" } ], "additionalItems": { "oneOf": [ { - "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius", + "description": "If WITHDIST option is specified, the distance from the center as a floating point number, in the same unit specified in the radius.", "type": "string" }, { - "description": "If WITHHASH option is specified, the geohash integer", + "description": "If WITHHASH option is specified, the geohash integer.", "type": "integer" }, { - "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude)", + "description": "If WITHCOORD option is specified, the coordinates as a two items x,y array (longitude,latitude).", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "latitude (x)", + "description": "Latitude (x).", "type": "number" }, { - "description": "longitude (y)", + "description": "Longitude (y).", "type": "number" } ] diff --git a/src/commands/geosearchstore.json b/src/commands/geosearchstore.json index dfbdaaaeca..0e7f61a8f8 100644 --- a/src/commands/geosearchstore.json +++ b/src/commands/geosearchstore.json @@ -221,7 +221,7 @@ } ], "reply_schema": { - "description": "the number of elements in the resulting set", + "description": "The number of elements in the resulting set.", "type": "integer" } } diff --git a/src/commands/hscan.json b/src/commands/hscan.json index 99e916574f..9e6099c2f2 100644 --- a/src/commands/hscan.json +++ b/src/commands/hscan.json @@ -65,17 +65,17 @@ } ], "reply_schema": { - "description": "cursor and scan response in array form", + "description": "Cursor and scan response in array form.", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "cursor", + "description": "Cursor.", "type": "string" }, { - "description": "list of key/value pairs from the hash where each even element is the key, and each odd element is the value, or when novalues option is on, a list of keys from the hash", + "description": "List of key/value pairs from the hash where each even element is the key, and each odd element is the value, or when novalues option is on, a list of keys from the hash.", "type": "array", "items": { "type": "string" diff --git a/src/commands/keys.json b/src/commands/keys.json index 9dd4e1101b..2aa9c280fd 100644 --- a/src/commands/keys.json +++ b/src/commands/keys.json @@ -24,7 +24,7 @@ } ], "reply_schema": { - "description": "list of keys matching pattern", + "description": "List of keys matching pattern.", "type": "array", "items": { "type": "string" diff --git a/src/commands/latency-history.json b/src/commands/latency-history.json index 7c3591aa2d..0c825004eb 100644 --- a/src/commands/latency-history.json +++ b/src/commands/latency-history.json @@ -27,12 +27,12 @@ "maxItems": 2, "items": [ { - "description": "timestamp of the event", + "description": "Timestamp of the event.", "type": "integer", "minimum": 0 }, { - "description": "latency of the event", + "description": "Latency of the event.", "type": "integer", "minimum": 0 } diff --git a/src/commands/linsert.json b/src/commands/linsert.json index 8059dc50d4..f26e679f8c 100644 --- a/src/commands/linsert.json +++ b/src/commands/linsert.json @@ -41,11 +41,11 @@ "minimum": 1 }, { - "description": "in case key doesn't exist.", + "description": "In case key doesn't exist.", "const": 0 }, { - "description": "when the pivot wasn't found.", + "description": "When the pivot wasn't found.", "const": -1 } ] diff --git a/src/commands/lpushx.json b/src/commands/lpushx.json index 5f6d17cbc7..59a31539c9 100644 --- a/src/commands/lpushx.json +++ b/src/commands/lpushx.json @@ -42,7 +42,7 @@ ], "reply_schema": { "type": "integer", - "description": "the length of the list after the push operation", + "description": "The length of the list after the push operation.", "minimum": 0 }, "arguments": [ diff --git a/src/commands/memory-doctor.json b/src/commands/memory-doctor.json index c0c8c22a8e..7bc0e1e6e2 100644 --- a/src/commands/memory-doctor.json +++ b/src/commands/memory-doctor.json @@ -13,7 +13,7 @@ "RESPONSE_POLICY:SPECIAL" ], "reply_schema": { - "description": "memory problems report", + "description": "Memory problems report.", "type": "string" } } diff --git a/src/commands/memory-stats.json b/src/commands/memory-stats.json index 98e49b7d27..e32f5a291b 100644 --- a/src/commands/memory-stats.json +++ b/src/commands/memory-stats.json @@ -13,7 +13,7 @@ "RESPONSE_POLICY:SPECIAL" ], "reply_schema": { - "description": "memory usage details", + "description": "Memory usage details.", "type": "object", "additionalProperties": false, "properties": { diff --git a/src/commands/move.json b/src/commands/move.json index 203068067f..54ec2f21ec 100644 --- a/src/commands/move.json +++ b/src/commands/move.json @@ -48,11 +48,11 @@ "reply_schema": { "oneOf": [ { - "description": "key was moved", + "description": "Key was moved.", "const": 1 }, { - "description": "key wasn't moved", + "description": "Key wasn't moved.", "const": 0 } ] diff --git a/src/commands/object-encoding.json b/src/commands/object-encoding.json index 3fab4aadb5..4ccf3f04b6 100644 --- a/src/commands/object-encoding.json +++ b/src/commands/object-encoding.json @@ -45,11 +45,11 @@ "reply_schema": { "oneOf": [ { - "description": "key doesn't exist", + "description": "Key doesn't exist.", "type": "null" }, { - "description": "encoding of the object", + "description": "Encoding of the object.", "type": "string" } ] diff --git a/src/commands/object-freq.json b/src/commands/object-freq.json index 7a7553b188..7e1b2e24e1 100644 --- a/src/commands/object-freq.json +++ b/src/commands/object-freq.json @@ -43,7 +43,7 @@ } ], "reply_schema": { - "description": "the counter's value", + "description": "The counter's value.", "type": "integer" } } diff --git a/src/commands/object-idletime.json b/src/commands/object-idletime.json index dc1d254c8e..372ff3ad00 100644 --- a/src/commands/object-idletime.json +++ b/src/commands/object-idletime.json @@ -43,7 +43,7 @@ } ], "reply_schema": { - "description": "the idle time in seconds", + "description": "The idle time in seconds.", "type": "integer" } } diff --git a/src/commands/object-refcount.json b/src/commands/object-refcount.json index 48009bbf75..3586f85a0f 100644 --- a/src/commands/object-refcount.json +++ b/src/commands/object-refcount.json @@ -43,7 +43,7 @@ } ], "reply_schema": { - "description": "the number of references", + "description": "The number of references.", "type": "integer" } } diff --git a/src/commands/pfadd.json b/src/commands/pfadd.json index 7d8448ad89..769a2f010c 100644 --- a/src/commands/pfadd.json +++ b/src/commands/pfadd.json @@ -50,11 +50,11 @@ "reply_schema": { "oneOf": [ { - "description": "if at least 1 HyperLogLog internal register was altered", + "description": "If at least 1 HyperLogLog internal register was altered.", "const": 1 }, { - "description": "if no HyperLogLog internal register were altered", + "description": "If no HyperLogLog internal register were altered.", "const": 0 } ] diff --git a/src/commands/publish.json b/src/commands/publish.json index 51890bf9c7..0dade72064 100644 --- a/src/commands/publish.json +++ b/src/commands/publish.json @@ -25,7 +25,7 @@ } ], "reply_schema": { - "description": "the number of clients that received the message. Note that in a Cluster, only clients that are connected to the same node as the publishing client are included in the count", + "description": "The number of clients that received the message. Note that in a Cluster, only clients that are connected to the same node as the publishing client are included in the count.", "type": "integer", "minimum": 0 } diff --git a/src/commands/pubsub-channels.json b/src/commands/pubsub-channels.json index 08505b3eba..1060131620 100644 --- a/src/commands/pubsub-channels.json +++ b/src/commands/pubsub-channels.json @@ -20,7 +20,7 @@ } ], "reply_schema": { - "description": "a list of active channels, optionally matching the specified pattern", + "description": "A list of active channels, optionally matching the specified pattern.", "type": "array", "uniqueItems": true, "items": { diff --git a/src/commands/pubsub-numpat.json b/src/commands/pubsub-numpat.json index ae653b74f6..8d3114f2e6 100644 --- a/src/commands/pubsub-numpat.json +++ b/src/commands/pubsub-numpat.json @@ -13,7 +13,7 @@ "STALE" ], "reply_schema": { - "description": "the number of patterns all the clients are subscribed to", + "description": "The number of patterns all the clients are subscribed to.", "type": "integer", "minimum": 0 } diff --git a/src/commands/pubsub-numsub.json b/src/commands/pubsub-numsub.json index 1cfe8e2ef1..e4b4ccdce4 100644 --- a/src/commands/pubsub-numsub.json +++ b/src/commands/pubsub-numsub.json @@ -21,7 +21,7 @@ } ], "reply_schema": { - "description": "the number of subscribers per channel, each even element (including 0th) is channel name, each odd element is the number of subscribers", + "description": "The number of subscribers per channel, each even element (including 0th) is channel name, each odd element is the number of subscribers.", "type": "array" } } diff --git a/src/commands/pubsub-shardchannels.json b/src/commands/pubsub-shardchannels.json index 7aa0a7a878..921a4a4327 100644 --- a/src/commands/pubsub-shardchannels.json +++ b/src/commands/pubsub-shardchannels.json @@ -20,7 +20,7 @@ } ], "reply_schema": { - "description": "a list of active channels, optionally matching the specified pattern", + "description": "A list of active channels, optionally matching the specified pattern.", "type": "array", "items": { "type": "string" diff --git a/src/commands/pubsub-shardnumsub.json b/src/commands/pubsub-shardnumsub.json index 43675340fa..8eeca4e31b 100644 --- a/src/commands/pubsub-shardnumsub.json +++ b/src/commands/pubsub-shardnumsub.json @@ -21,7 +21,7 @@ } ], "reply_schema": { - "description": "the number of subscribers per shard channel, each even element (including 0th) is channel name, each odd element is the number of subscribers", + "description": "The number of subscribers per shard channel, each even element (including 0th) is channel name, each odd element is the number of subscribers.", "type": "array" } } diff --git a/src/commands/randomkey.json b/src/commands/randomkey.json index eeef61aef1..29e54f6e24 100644 --- a/src/commands/randomkey.json +++ b/src/commands/randomkey.json @@ -21,11 +21,11 @@ "reply_schema": { "oneOf": [ { - "description": "when the database is empty", + "description": "When the database is empty.", "type": "null" }, { - "description": "random key in db", + "description": "Random key in db.", "type": "string" } ] diff --git a/src/commands/renamenx.json b/src/commands/renamenx.json index 72f0569d8e..e59c53bfcc 100644 --- a/src/commands/renamenx.json +++ b/src/commands/renamenx.json @@ -73,11 +73,11 @@ "reply_schema": { "oneOf": [ { - "description": "key was renamed to newkey", + "description": "Key was renamed to newkey.", "const": 1 }, { - "description": "new key already exists", + "description": "New key already exists.", "const": 0 } ] diff --git a/src/commands/replicaof.json b/src/commands/replicaof.json index 95e5cb400b..6ddedf2d68 100644 --- a/src/commands/replicaof.json +++ b/src/commands/replicaof.json @@ -51,7 +51,7 @@ } ], "reply_schema": { - "description": "replicaOf status", + "description": "ReplicaOf status.", "type": "string", "pattern": "OK*" } diff --git a/src/commands/role.json b/src/commands/role.json index a0299fa73e..1c3a4490ca 100644 --- a/src/commands/role.json +++ b/src/commands/role.json @@ -28,11 +28,11 @@ "const": "master" }, { - "description": "current replication master offset", + "description": "Current replication master offset.", "type": "integer" }, { - "description": "connected replicas", + "description": "Connected replicas.", "type": "array", "items": { "type": "array", @@ -40,15 +40,15 @@ "maxItems": 3, "items": [ { - "description": "replica ip", + "description": "Replica IP.", "type": "string" }, { - "description": "replica port", + "description": "Replica port.", "type": "string" }, { - "description": "last acknowledged replication offset", + "description": "Last acknowledged replication offset.", "type": "string" } ] @@ -65,48 +65,48 @@ "const": "slave" }, { - "description": "ip of master", + "description": "IP of master.", "type": "string" }, { - "description": "port number of master", + "description": "Port number of master.", "type": "integer" }, { - "description": "state of the replication from the point of view of the master", + "description": "State of the replication from the point of view of the master.", "oneOf": [ { - "description": "the instance is in handshake with its master", + "description": "The instance is in handshake with its master.", "const": "handshake" }, { - "description": "the instance in not active", + "description": "The instance in not active.", "const": "none" }, { - "description": "the instance needs to connect to its master", + "description": "The instance needs to connect to its master.", "const": "connect" }, { - "description": "the master-replica connection is in progress", + "description": "The master-replica connection is in progress.", "const": "connecting" }, { - "description": "the master and replica are trying to perform the synchronization", + "description": "The master and replica are trying to perform the synchronization.", "const": "sync" }, { - "description": "the replica is online", + "description": "The replica is online.", "const": "connected" }, { - "description": "instance state is unknown", + "description": "Instance state is unknown.", "const": "unknown" } ] }, { - "description": "the amount of data received from the replica so far in terms of master replication offset", + "description": "The amount of data received from the replica so far in terms of master replication offset.", "type": "integer" } ] @@ -120,7 +120,7 @@ "const": "sentinel" }, { - "description": "list of master names monitored by this sentinel instance", + "description": "List of master names monitored by this sentinel instance.", "type": "array", "items": { "type": "string" diff --git a/src/commands/scan.json b/src/commands/scan.json index a7df78a218..2b43c98056 100644 --- a/src/commands/scan.json +++ b/src/commands/scan.json @@ -50,17 +50,17 @@ } ], "reply_schema": { - "description": "cursor and scan response in array form", + "description": "Cursor and scan response in array form.", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "cursor", + "description": "Cursor.", "type": "string" }, { - "description": "list of keys", + "description": "List of keys.", "type": "array", "items": { "type": "string" diff --git a/src/commands/script-exists.json b/src/commands/script-exists.json index d8c47e4824..6c98fd78be 100644 --- a/src/commands/script-exists.json +++ b/src/commands/script-exists.json @@ -30,11 +30,11 @@ "items": { "oneOf": [ { - "description": "sha1 hash exists in script cache", + "description": "Sha1 hash exists in script cache.", "const": 1 }, { - "description": "sha1 hash does not exist in script cache", + "description": "Sha1 hash does not exist in script cache.", "const": 0 } ] diff --git a/src/commands/slaveof.json b/src/commands/slaveof.json index af5b54fae0..ca30982887 100644 --- a/src/commands/slaveof.json +++ b/src/commands/slaveof.json @@ -56,7 +56,7 @@ } ], "reply_schema": { - "description": "slaveOf status", + "description": "SlaveOf status.", "type": "string", "pattern": "OK*" } diff --git a/src/commands/sort.json b/src/commands/sort.json index d5f6511142..f2bd187e36 100644 --- a/src/commands/sort.json +++ b/src/commands/sort.json @@ -137,12 +137,12 @@ "reply_schema": { "oneOf": [ { - "description": "when the store option is specified the command returns the number of sorted elements in the destination list", + "description": "When the store option is specified the command returns the number of sorted elements in the destination list.", "type": "integer", "minimum": 0 }, { - "description": "when not passing the store option the command returns a list of sorted elements", + "description": "When not passing the store option the command returns a list of sorted elements.", "type": "array", "items": { "oneOf": [ @@ -150,7 +150,7 @@ "type": "string" }, { - "description": "GET option is specified, but no object was found", + "description": "GET option is specified, but no object was found.", "type": "null" } ] diff --git a/src/commands/sort_ro.json b/src/commands/sort_ro.json index 04cc3c8417..668888cfcc 100644 --- a/src/commands/sort_ro.json +++ b/src/commands/sort_ro.json @@ -114,7 +114,7 @@ } ], "reply_schema": { - "description": "a list of sorted elements", + "description": "A list of sorted elements.", "type": "array", "items": { "oneOf": [ @@ -122,7 +122,7 @@ "type": "string" }, { - "description": "GET option is specified, but no object was found", + "description": "GET option is specified, but no object was found.", "type": "null" } ] diff --git a/src/commands/spublish.json b/src/commands/spublish.json index 1016bd2826..da1360de7c 100644 --- a/src/commands/spublish.json +++ b/src/commands/spublish.json @@ -43,7 +43,7 @@ } ], "reply_schema": { - "description": "the number of clients that received the message. Note that in a Cluster, only clients that are connected to the same node as the publishing client are included in the count", + "description": "The number of clients that received the message. Note that in a Cluster, only clients that are connected to the same node as the publishing client are included in the count.", "type": "integer", "minimum": 0 } diff --git a/src/commands/sscan.json b/src/commands/sscan.json index b221c94cf1..1b78ee3db3 100644 --- a/src/commands/sscan.json +++ b/src/commands/sscan.json @@ -59,17 +59,17 @@ } ], "reply_schema": { - "description": "cursor and scan response in array form", + "description": "Cursor and scan response in array form.", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "cursor", + "description": "Cursor.", "type": "string" }, { - "description": "list of set members", + "description": "List of set members.", "type": "array", "items": { "type": "string" diff --git a/src/commands/touch.json b/src/commands/touch.json index fd1dc61c3b..03fc7b8de3 100644 --- a/src/commands/touch.json +++ b/src/commands/touch.json @@ -45,7 +45,7 @@ } ], "reply_schema": { - "description": "the number of touched keys", + "description": "The number of touched keys.", "type": "integer", "minimum": 0 } diff --git a/src/commands/unlink.json b/src/commands/unlink.json index a05704a1b3..81892b35ec 100644 --- a/src/commands/unlink.json +++ b/src/commands/unlink.json @@ -46,7 +46,7 @@ } ], "reply_schema": { - "description": "the number of keys that were unlinked", + "description": "The number of keys that were unlinked.", "type": "integer", "minimum": 0 } diff --git a/src/commands/xclaim.json b/src/commands/xclaim.json index 5c44746067..a908a0de87 100644 --- a/src/commands/xclaim.json +++ b/src/commands/xclaim.json @@ -100,16 +100,16 @@ "description": "Stream entries with IDs matching the specified range.", "anyOf": [ { - "description": "If JUSTID option is specified, return just an array of IDs of messages successfully claimed", + "description": "If JUSTID option is specified, return just an array of IDs of messages successfully claimed.", "type": "array", "items": { - "description": "Entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" } }, { - "description": "array of stream entries that contains each entry as an array of 2 elements, the Entry ID and the entry data itself", + "description": "Array of stream entries that contains each entry as an array of 2 elements, the Entry ID and the entry data itself.", "type": "array", "uniqueItems": true, "items": { @@ -118,12 +118,12 @@ "maxItems": 2, "items": [ { - "description": "Entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "Data", + "description": "Data.", "type": "array", "items": { "type": "string" diff --git a/src/commands/xinfo-stream.json b/src/commands/xinfo-stream.json index 609dc336d5..f98ea6acdc 100644 --- a/src/commands/xinfo-stream.json +++ b/src/commands/xinfo-stream.json @@ -55,42 +55,42 @@ "additionalProperties": false, "properties": { "length": { - "description": "the number of entries in the stream (see `XLEN`)", + "description": "The number of entries in the stream (see `XLEN`).", "type": "integer" }, "radix-tree-keys": { - "description": "the number of keys in the underlying radix data structure", + "description": "The number of keys in the underlying radix data structure.", "type": "integer" }, "radix-tree-nodes": { - "description": "the number of nodes in the underlying radix data structure", + "description": "The number of nodes in the underlying radix data structure.", "type": "integer" }, "last-generated-id": { - "description": "the ID of the least-recently entry that was added to the stream", + "description": "The ID of the least-recently entry that was added to the stream.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "max-deleted-entry-id": { - "description": "the maximal entry ID that was deleted from the stream", + "description": "The maximal entry ID that was deleted from the stream.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "recorded-first-entry-id": { - "description": "cached copy of the first entry ID", + "description": "Cached copy of the first entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "entries-added": { - "description": "the count of all entries added to the stream during its lifetime", + "description": "The count of all entries added to the stream during its lifetime.", "type": "integer" }, "groups": { - "description": "the number of consumer groups defined for the stream", + "description": "The number of consumer groups defined for the stream.", "type": "integer" }, "first-entry": { - "description": "the first entry of the stream", + "description": "The first entry of the stream.", "oneOf": [ { "type": "null" @@ -101,12 +101,12 @@ "maxItems": 2, "items": [ { - "description": "entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "data", + "description": "Data.", "type": "array", "items": { "type": "string" @@ -117,7 +117,7 @@ ] }, "last-entry": { - "description": "the last entry of the stream", + "description": "The last entry of the stream.", "oneOf": [ { "type": "null" @@ -128,12 +128,12 @@ "maxItems": 2, "items": [ { - "description": "entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "data", + "description": "Data.", "type": "array", "items": { "type": "string" @@ -151,38 +151,38 @@ "additionalProperties": false, "properties": { "length": { - "description": "the number of entries in the stream (see `XLEN`)", + "description": "The number of entries in the stream (see `XLEN`).", "type": "integer" }, "radix-tree-keys": { - "description": "the number of keys in the underlying radix data structure", + "description": "The number of keys in the underlying radix data structure.", "type": "integer" }, "radix-tree-nodes": { - "description": "the number of nodes in the underlying radix data structure", + "description": "The number of nodes in the underlying radix data structure.", "type": "integer" }, "last-generated-id": { - "description": "the ID of the least-recently entry that was added to the stream", + "description": "The ID of the least-recently entry that was added to the stream.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "max-deleted-entry-id": { - "description": "the maximal entry ID that was deleted from the stream", + "description": "The maximal entry ID that was deleted from the stream.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "recorded-first-entry-id": { - "description": "cached copy of the first entry ID", + "description": "Cached copy of the first entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "entries-added": { - "description": "the count of all entries added to the stream during its lifetime", + "description": "The count of all entries added to the stream during its lifetime.", "type": "integer" }, "entries": { - "description": "all the entries of the stream", + "description": "All the entries of the stream.", "type": "array", "uniqueItems": true, "items": { @@ -191,12 +191,12 @@ "maxItems": 2, "items": [ { - "description": "entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "data", + "description": "Data.", "type": "array", "items": { "type": "string" @@ -212,16 +212,16 @@ "additionalProperties": false, "properties": { "name": { - "description": "group name", + "description": "Group name.", "type": "string" }, "last-delivered-id": { - "description": "last entry ID that was delivered to a consumer", + "description": "Last entry ID that was delivered to a consumer.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, "entries-read": { - "description": "total number of entries ever read by consumers in the group", + "description": "Total number of entries ever read by consumers in the group.", "oneOf": [ { "type": "null" @@ -232,7 +232,7 @@ ] }, "lag": { - "description": "number of entries left to be consumed from the stream", + "description": "Number of entries left to be consumed from the stream.", "oneOf": [ { "type": "null" @@ -243,11 +243,11 @@ ] }, "pel-count": { - "description": "total number of unacknowledged entries", + "description": "Total number of unacknowledged entries.", "type": "integer" }, "pending": { - "description": "data about all of the unacknowledged entries", + "description": "Data about all of the unacknowledged entries.", "type": "array", "items": { "type": "array", @@ -255,27 +255,27 @@ "maxItems": 4, "items": [ { - "description": "Entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "Consumer name", + "description": "Consumer name.", "type": "string" }, { - "description": "Delivery timestamp", + "description": "Delivery timestamp.", "type": "integer" }, { - "description": "Delivery count", + "description": "Delivery count.", "type": "integer" } ] } }, "consumers": { - "description": "data about all of the consumers of the group", + "description": "Data about all of the consumers of the group.", "type": "array", "items": { "type": "object", @@ -287,20 +287,20 @@ "minimum": 0 }, "name": { - "description": "consumer name", + "description": "Consumer name.", "type": "string" }, "seen-time": { - "description": "timestamp of the last interaction attempt of the consumer", + "description": "Timestamp of the last interaction attempt of the consumer.", "type": "integer", "minimum": 0 }, "pel-count": { - "description": "number of unacknowledged entries that belong to the consumer", + "description": "Number of unacknowledged entries that belong to the consumer.", "type": "integer" }, "pending": { - "description": "data about the unacknowledged entries", + "description": "Data about the unacknowledged entries.", "type": "array", "items": { "type": "array", @@ -308,16 +308,16 @@ "maxItems": 3, "items": [ { - "description": "Entry ID", + "description": "Entry ID.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "Delivery timestamp", + "description": "Delivery timestamp.", "type": "integer" }, { - "description": "Delivery count", + "description": "Delivery count.", "type": "integer" } ] diff --git a/src/commands/xread.json b/src/commands/xread.json index 95e22c494e..b448903bb6 100644 --- a/src/commands/xread.json +++ b/src/commands/xread.json @@ -69,11 +69,11 @@ "reply_schema": { "oneOf": [ { - "description": "A map of key-value elements when each element composed of key name and the entries reported for that key", + "description": "A map of key-value elements when each element composed of key name and the entries reported for that key.", "type": "object", "patternProperties": { "^.*$": { - "description": "The entries reported for that key", + "description": "The entries reported for that key.", "type": "array", "items": { "type": "array", @@ -81,12 +81,12 @@ "maxItems": 2, "items": [ { - "description": "entry id", + "description": "Entry id.", "type": "string", "pattern": "[0-9]+-[0-9]+" }, { - "description": "array of field-value pairs", + "description": "A map of key-value elements when each element composed of key name and the entries reported for that key.", "type": "array", "items": { "type": "string" @@ -98,7 +98,7 @@ } }, { - "description": "If BLOCK option is given, and a timeout occurs, or there is no stream we can serve", + "description": "If BLOCK option is given, and a timeout occurs, or there is no stream we can serve.", "type": "null" } ] diff --git a/src/commands/zrangebyscore.json b/src/commands/zrangebyscore.json index 557ef1dc62..c89607e104 100644 --- a/src/commands/zrangebyscore.json +++ b/src/commands/zrangebyscore.json @@ -47,29 +47,29 @@ "anyOf": [ { "type": "array", - "description": "List of the elements in the specified score range, as not WITHSCORES", + "description": "List of the elements in the specified score range, as not WITHSCORES.", "uniqueItems": true, "items": { "type": "string", - "description": "Element" + "description": "Element." } }, { "type": "array", - "description": "List of the elements and their scores in the specified score range, as WITHSCORES used", + "description": "List of the elements and their scores in the specified score range, as WITHSCORES used.", "uniqueItems": true, "items": { "type": "array", - "description": "Tuple of element and its score", + "description": "Tuple of element and its score.", "minItems": 2, "maxItems": 2, "items": [ { - "description": "element", + "description": "Element.", "type": "string" }, { - "description": "score", + "description": "Score.", "type": "number" } ] diff --git a/src/commands/zrevrange.json b/src/commands/zrevrange.json index 116fe82b24..a143f72153 100644 --- a/src/commands/zrevrange.json +++ b/src/commands/zrevrange.json @@ -57,11 +57,11 @@ "maxItems": 2, "items": [ { - "description": "member", + "description": "Member.", "type": "string" }, { - "description": "score", + "description": "Score.", "type": "number" } ] diff --git a/src/commands/zrevrangebyscore.json b/src/commands/zrevrangebyscore.json index ab040527e1..0eb9e86956 100644 --- a/src/commands/zrevrangebyscore.json +++ b/src/commands/zrevrangebyscore.json @@ -47,30 +47,30 @@ "anyOf": [ { "type": "array", - "description": "List of the elements in the specified score range, as not WITHSCORES", + "description": "List of the elements in the specified score range, as not WITHSCORES.", "uniqueItems": true, "items": { "type": "string", - "description": "Element" + "description": "Element." } }, { "type": "array", - "description": "List of the elements and their scores in the specified score range, as WITHSCORES used", + "description": "List of the elements and their scores in the specified score range, as WITHSCORES used.", "uniqueItems": true, "items": { "type": "array", - "description": "Tuple of element and its score", + "description": "Tuple of element and its score.", "minItems": 2, "maxItems": 2, "items": [ { "type": "string", - "description": "element" + "description": "Element." }, { "type": "number", - "description": "score" + "description": "Score." } ] } diff --git a/src/commands/zscan.json b/src/commands/zscan.json index 7c69ccf65a..edadb8561b 100644 --- a/src/commands/zscan.json +++ b/src/commands/zscan.json @@ -59,17 +59,17 @@ } ], "reply_schema": { - "description": "cursor and scan response in array form", + "description": "Cursor and scan response in array form.", "type": "array", "minItems": 2, "maxItems": 2, "items": [ { - "description": "cursor", + "description": "Cursor.", "type": "string" }, { - "description": "list of elements of the sorted set, where each even element is the member, and each odd value is its associated score", + "description": "List of elements of the sorted set, where each even element is the member, and each odd value is its associated score.", "type": "array", "items": { "type": "string"