Skip to content

Commit

Permalink
fix - the little inconsistencies in the json command file descriptions
Browse files Browse the repository at this point in the history
Signed-off-by: ItsAJ1005 <ajharshvardhan123@gmail.com>
  • Loading branch information
ItsAJ1005 committed Mar 31, 2024
1 parent af1b0de commit 2ed0a23
Show file tree
Hide file tree
Showing 18 changed files with 46 additions and 46 deletions.
6 changes: 3 additions & 3 deletions src/commands/acl-cat.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"
}
Expand Down
8 changes: 4 additions & 4 deletions src/commands/acl-deluser.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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": [
{
Expand Down
4 changes: 2 additions & 2 deletions src/commands/acl-dryrun.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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."
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions src/commands/acl-genpass.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand All @@ -25,4 +25,4 @@
}
]
}
}
}
14 changes: 7 additions & 7 deletions src/commands/acl-getuser.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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": {
Expand All @@ -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": {
Expand All @@ -82,10 +82,10 @@
}
},
{
"description": "If user does not exist",
"description": "If the user does not exist.",
"type": "null"
}
]
}
}
}
}
4 changes: 2 additions & 2 deletions src/commands/acl-help.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
}
}
6 changes: 3 additions & 3 deletions src/commands/acl-list.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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"
}
}
}
}
}
4 changes: 2 additions & 2 deletions src/commands/acl-load.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -18,4 +18,4 @@
"const": "OK"
}
}
}
}
2 changes: 1 addition & 1 deletion src/commands/acl-log.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@
}
]
}
}
}
8 changes: 4 additions & 4 deletions src/commands/acl-save.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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"
}
}
}
}
10 changes: 5 additions & 5 deletions src/commands/acl-setuser.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -14,7 +14,7 @@
],
[
"7.0.0",
"Added selectors and key based permissions."
"Added selectors and key-based permissions."
]
],
"command_flags": [
Expand All @@ -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"
Expand All @@ -44,4 +44,4 @@
}
]
}
}
}
6 changes: 3 additions & 3 deletions src/commands/acl-users.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -16,10 +16,10 @@
],
"reply_schema": {
"type": "array",
"description": "List of existing ACL users",
"description": "List of existing ACL users.",
"items": {
"type": "string"
}
}
}
}
}
2 changes: 1 addition & 1 deletion src/commands/acl-whoami.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
"description": "The username of the current connection."
}
}
}
}
4 changes: 2 additions & 2 deletions src/commands/acl.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"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,
"command_flags": [
"SENTINEL"
]
}
}
}
2 changes: 1 addition & 1 deletion src/commands/append.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@
}
]
}
}
}
2 changes: 1 addition & 1 deletion src/commands/asking.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
"const": "OK"
}
}
}
}
4 changes: 2 additions & 2 deletions src/commands/auth.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -40,4 +40,4 @@
}
]
}
}
}
2 changes: 1 addition & 1 deletion src/commands/xgroup-help.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down

0 comments on commit 2ed0a23

Please sign in to comment.