From 2ed0a2337140530023f6532b6a3d7540dc54245c Mon Sep 17 00:00:00 2001 From: ItsAJ1005 Date: Sun, 31 Mar 2024 17:04:34 +0530 Subject: [PATCH] fix - the little inconsistencies in the json command file descriptions Signed-off-by: ItsAJ1005 --- src/commands/acl-cat.json | 6 +++--- src/commands/acl-deluser.json | 8 ++++---- src/commands/acl-dryrun.json | 4 ++-- src/commands/acl-genpass.json | 4 ++-- src/commands/acl-getuser.json | 14 +++++++------- src/commands/acl-help.json | 4 ++-- src/commands/acl-list.json | 6 +++--- src/commands/acl-load.json | 4 ++-- src/commands/acl-log.json | 2 +- src/commands/acl-save.json | 8 ++++---- src/commands/acl-setuser.json | 10 +++++----- src/commands/acl-users.json | 6 +++--- src/commands/acl-whoami.json | 2 +- src/commands/acl.json | 4 ++-- src/commands/append.json | 2 +- src/commands/asking.json | 2 +- src/commands/auth.json | 4 ++-- src/commands/xgroup-help.json | 2 +- 18 files changed, 46 insertions(+), 46 deletions(-) diff --git a/src/commands/acl-cat.json b/src/commands/acl-cat.json index dfbe4c43ef..001205a852 100644 --- a/src/commands/acl-cat.json +++ b/src/commands/acl-cat.json @@ -1,6 +1,6 @@ { "CAT": { - "summary": "Lists the ACL categories, or the commands inside a category.", + "summary": "Lists the ACL categories or the commands inside a category.", "complexity": "O(1) since the categories and commands are a fixed set.", "group": "server", "since": "6.0.0", @@ -17,14 +17,14 @@ "anyOf": [ { "type": "array", - "description": "In case `category` was not given, a list of existing ACL categories", + "description": "If `category` was not given, a list of existing ACL categories.", "items": { "type": "string" } }, { "type": "array", - "description": "In case `category` was given, list of commands that fall under the provided ACL category", + "description": "If `category` was given, a 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..17e4b7ca31 100644 --- a/src/commands/acl-deluser.json +++ b/src/commands/acl-deluser.json @@ -1,6 +1,6 @@ { "DELUSER": { - "summary": "Deletes ACL users, and terminates their connections.", + "summary": "Deletes ACL users and terminates their connections.", "complexity": "O(1) amortized time considering the typical user.", "group": "server", "since": "6.0.0", @@ -15,12 +15,12 @@ "SENTINEL" ], "command_tips": [ - "REQUEST_POLICY:ALL_NODES", - "RESPONSE_POLICY:ALL_SUCCEEDED" + "REQUEST_POLICY:ALL_NODES", + "RESPONSE_POLICY:ALL_SUCCEEDED" ], "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-dryrun.json b/src/commands/acl-dryrun.json index bee6a6aac5..907b5158b8 100644 --- a/src/commands/acl-dryrun.json +++ b/src/commands/acl-dryrun.json @@ -1,6 +1,6 @@ { "DRYRUN": { - "summary": "Simulates the execution of a command by a user, without executing the command.", + "summary": "Simulates the execution of a command by a user without executing the command.", "complexity": "O(1).", "group": "server", "since": "7.0.0", @@ -23,7 +23,7 @@ }, { "type": "string", - "description": "The description of the problem, in case the user is not allowed to run the given command." + "description": "The description of the problem in case the user is not allowed to run the given command." } ] }, diff --git a/src/commands/acl-genpass.json b/src/commands/acl-genpass.json index 86c1f8e29b..02a418869f 100644 --- a/src/commands/acl-genpass.json +++ b/src/commands/acl-genpass.json @@ -15,7 +15,7 @@ ], "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." + "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": [ { @@ -25,4 +25,4 @@ } ] } -} +} \ No newline at end of file diff --git a/src/commands/acl-getuser.json b/src/commands/acl-getuser.json index 535389bc53..d632202554 100644 --- a/src/commands/acl-getuser.json +++ b/src/commands/acl-getuser.json @@ -1,7 +1,7 @@ { "GETUSER": { "summary": "Lists the ACL rules of a user.", - "complexity": "O(N). Where N is the number of password, command and pattern rules that the user has.", + "complexity": "O(N) where N is the number of password, command, and pattern rules that the user has.", "group": "server", "since": "6.0.0", "arity": 3, @@ -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": { @@ -82,10 +82,10 @@ } }, { - "description": "If user does not exist", + "description": "If the user does not exist.", "type": "null" } ] } } -} +} \ No newline at end of file diff --git a/src/commands/acl-help.json b/src/commands/acl-help.json index 3c95914dbd..66966893cd 100644 --- a/src/commands/acl-help.json +++ b/src/commands/acl-help.json @@ -14,10 +14,10 @@ ], "reply_schema": { "type": "array", - "description": "A list of subcommands and their description", + "description": "A list of subcommands and their descriptions.", "items": { "type": "string" } } } -} +} \ No newline at end of file diff --git a/src/commands/acl-list.json b/src/commands/acl-list.json index 0d75b137f3..73ad7e515b 100644 --- a/src/commands/acl-list.json +++ b/src/commands/acl-list.json @@ -1,7 +1,7 @@ { "LIST": { "summary": "Dumps the effective rules in ACL file format.", - "complexity": "O(N). Where N is the number of configured users.", + "complexity": "O(N) where N is the number of configured users.", "group": "server", "since": "6.0.0", "arity": 2, @@ -16,10 +16,10 @@ ], "reply_schema": { "type": "array", - "description": "A list of currently active ACL rules", + "description": "A list of currently active ACL rules.", "items": { "type": "string" } } } -} +} \ No newline at end of file diff --git a/src/commands/acl-load.json b/src/commands/acl-load.json index d7b91ba610..130572d073 100644 --- a/src/commands/acl-load.json +++ b/src/commands/acl-load.json @@ -1,7 +1,7 @@ { "LOAD": { "summary": "Reloads the rules from the configured ACL file.", - "complexity": "O(N). Where N is the number of configured users.", + "complexity": "O(N) where N is the number of configured users.", "group": "server", "since": "6.0.0", "arity": 2, @@ -18,4 +18,4 @@ "const": "OK" } } -} +} \ No newline at end of file diff --git a/src/commands/acl-log.json b/src/commands/acl-log.json index de5f029e47..11f21dc897 100644 --- a/src/commands/acl-log.json +++ b/src/commands/acl-log.json @@ -87,4 +87,4 @@ } ] } -} +} \ No newline at end of file diff --git a/src/commands/acl-save.json b/src/commands/acl-save.json index 98d8dfd34b..b226d4f12e 100644 --- a/src/commands/acl-save.json +++ b/src/commands/acl-save.json @@ -1,7 +1,7 @@ { "SAVE": { "summary": "Saves the effective ACL rules in the configured ACL file.", - "complexity": "O(N). Where N is the number of configured users.", + "complexity": "O(N) where N is the number of configured users.", "group": "server", "since": "6.0.0", "arity": 2, @@ -15,11 +15,11 @@ "SENTINEL" ], "command_tips": [ - "REQUEST_POLICY:ALL_NODES", - "RESPONSE_POLICY:ALL_SUCCEEDED" + "REQUEST_POLICY:ALL_NODES", + "RESPONSE_POLICY:ALL_SUCCEEDED" ], "reply_schema": { "const": "OK" } } -} +} \ No newline at end of file diff --git a/src/commands/acl-setuser.json b/src/commands/acl-setuser.json index 1a909170f1..4f2d99b6af 100644 --- a/src/commands/acl-setuser.json +++ b/src/commands/acl-setuser.json @@ -1,7 +1,7 @@ { "SETUSER": { "summary": "Creates and modifies an ACL user and its rules.", - "complexity": "O(N). Where N is the number of rules provided.", + "complexity": "O(N) where N is the number of rules provided.", "group": "server", "since": "6.0.0", "arity": -3, @@ -14,7 +14,7 @@ ], [ "7.0.0", - "Added selectors and key based permissions." + "Added selectors and key-based permissions." ] ], "command_flags": [ @@ -25,8 +25,8 @@ "SENTINEL" ], "command_tips": [ - "REQUEST_POLICY:ALL_NODES", - "RESPONSE_POLICY:ALL_SUCCEEDED" + "REQUEST_POLICY:ALL_NODES", + "RESPONSE_POLICY:ALL_SUCCEEDED" ], "reply_schema": { "const": "OK" @@ -44,4 +44,4 @@ } ] } -} +} \ No newline at end of file diff --git a/src/commands/acl-users.json b/src/commands/acl-users.json index 1a6bc75579..d3261e049f 100644 --- a/src/commands/acl-users.json +++ b/src/commands/acl-users.json @@ -1,7 +1,7 @@ { "USERS": { "summary": "Lists all ACL users.", - "complexity": "O(N). Where N is the number of configured users.", + "complexity": "O(N) where N is the number of configured users.", "group": "server", "since": "6.0.0", "arity": 2, @@ -16,10 +16,10 @@ ], "reply_schema": { "type": "array", - "description": "List of existing ACL users", + "description": "List of existing ACL users.", "items": { "type": "string" } } } -} +} \ No newline at end of file diff --git a/src/commands/acl-whoami.json b/src/commands/acl-whoami.json index 2efe98c52f..36319e6c1c 100644 --- a/src/commands/acl-whoami.json +++ b/src/commands/acl-whoami.json @@ -18,4 +18,4 @@ "description": "The username of the current connection." } } -} +} \ No newline at end of file diff --git a/src/commands/acl.json b/src/commands/acl.json index 1474b782fa..634d0997a8 100644 --- a/src/commands/acl.json +++ b/src/commands/acl.json @@ -1,7 +1,7 @@ { "ACL": { "summary": "A container for Access List Control commands.", - "complexity": "Depends on subcommand.", + "complexity": "Depends on the subcommand.", "group": "server", "since": "6.0.0", "arity": -2, @@ -9,4 +9,4 @@ "SENTINEL" ] } -} +} \ No newline at end of file diff --git a/src/commands/append.json b/src/commands/append.json index cc0912df7a..87c9b65481 100644 --- a/src/commands/append.json +++ b/src/commands/append.json @@ -50,4 +50,4 @@ } ] } -} +} \ No newline at end of file diff --git a/src/commands/asking.json b/src/commands/asking.json index 3886795090..b1db68f651 100644 --- a/src/commands/asking.json +++ b/src/commands/asking.json @@ -16,4 +16,4 @@ "const": "OK" } } -} +} \ No newline at end of file diff --git a/src/commands/auth.json b/src/commands/auth.json index 3b1ba35430..8222a0614a 100644 --- a/src/commands/auth.json +++ b/src/commands/auth.json @@ -1,7 +1,7 @@ { "AUTH": { "summary": "Authenticates the connection.", - "complexity": "O(N) where N is the number of passwords defined for the user", + "complexity": "O(N) where N is the number of passwords defined for the user.", "group": "connection", "since": "1.0.0", "arity": -2, @@ -40,4 +40,4 @@ } ] } -} +} \ No newline at end of file diff --git a/src/commands/xgroup-help.json b/src/commands/xgroup-help.json index 3d2a738620..1ece30cad3 100644 --- a/src/commands/xgroup-help.json +++ b/src/commands/xgroup-help.json @@ -16,7 +16,7 @@ ], "reply_schema": { "type": "array", - "description": "Helpful text about subcommands.", + "description": "Returns an array containing helpful text about subcommands.", "items": { "type": "string" }