Phase 2 - server group commands

Author: dwdougherty

content/commands/acl-cat.md

@@ -119,6 +119,14 @@ Then we may want to know what commands are part of a given category:
 31) "sort"
 ```
 
+## Optional arguments
+
+<details open><summary><code>category</code></summary>
+
+List only the commands in the given ACL category. If omitted, all categories are listed.
+
+</details>
+
 ## Redis Software and Redis Cloud compatibility
 
 | Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |

content/commands/acl-deluser.md

@@ -44,6 +44,14 @@ removed from the system, this is the default user that every new connection
 is authenticated with. The list of users may include usernames that do not
 exist, in such case no operation is performed for the non existing users.
 
+## Required arguments
+
+<details open><summary><code>username [username ...]</code></summary>
+
+One or more usernames to delete.
+
+</details>
+
 ## Examples
 
 ```

content/commands/acl-dryrun.md

@@ -46,6 +46,28 @@ title: ACL DRYRUN
 Simulate the execution of a given command by a given user.
 This command can be used to test the permissions of a given user without having to enable the user or cause the side effects of running the command.
 
+## Required arguments
+
+<details open><summary><code>username</code></summary>
+
+The user to run the simulated command as.
+
+</details>
+
+<details open><summary><code>command</code></summary>
+
+The command to test.
+
+</details>
+
+## Optional arguments
+
+<details open><summary><code>arg [arg ...]</code></summary>
+
+The arguments to pass to the tested command.
+
+</details>
+
 ## Examples
 
 ```

content/commands/acl-genpass.md

@@ -57,10 +57,18 @@ The command output is a hexadecimal representation of a binary string.
 By default it emits 256 bits (so 64 hex characters). The user can provide
 an argument in form of number of bits to emit from 1 to 1024 to change
 the output length. Note that the number of bits provided is always
-rounded to the next multiple of 4. So for instance asking for just 1
+rounded to the next multiple of 4. So for instance asking for just a 1
 bit password will result in 4 bits to be emitted, in the form of a single
 hex character.
 
+## Optional arguments
+
+<details open><summary><code>bits</code></summary>
+
+The amount of entropy, in bits, for the generated password. Defaults to 256.
+
+</details>
+
 ## Examples
 
 ```

content/commands/acl-getuser.md

@@ -52,6 +52,14 @@ Note: This description of command rules reflects the user's effective permission
 
 Selectors are listed in the order they were applied to the user, and include information about commands, key patterns, and channel patterns.
 
+## Required arguments
+
+<details open><summary><code>username</code></summary>
+
+The user whose rules to return.
+
+</details>
+
 ## Examples
 
 Here's an example configuration for a user

content/commands/acl-log.md

@@ -57,6 +57,14 @@ The optional argument specifies how many entries to show. By default
 up to ten failures are returned. The special [`RESET`]({{< relref "/commands/reset" >}}) argument clears the log.
 Entries are displayed starting from the most recent.
 
+## Optional arguments
+
+<details open><summary><code>count | RESET</code></summary>
+
+The number of recent entries to return, or `RESET` to clear the log.
+
+</details>
+
 ## Examples
 
 ```
@@ -85,6 +93,8 @@ Entries are displayed starting from the most recent.
    20) (integer) 1675361492408
 ```
 
+## Details
+
 Each log entry is composed of the following fields:
 
 1. `count`: The number of security events detected within a 60 second period that are represented by this entry.

content/commands/acl-setuser.md

@@ -98,12 +98,39 @@ For information on persisting ACLs, see the [ACL tutorial]({{< relref "/operate/
 
 The following documentation is a reference manual about the capabilities of this command, however our [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) may be a more gentle introduction to how the ACL system works in general.
 
-## ACL rules
+## Required arguments
+
+<details open><summary><code>username</code></summary>
+
+The user to create or modify.
+
+</details>
+
+## Optional arguments
+
+<details open><summary><code>rule [rule ...]</code></summary>
+
+One or more ACL rules to apply to the user. See the [ACL rules](#acl-rules) section for the full list of rules.
+
+</details>
+
+## Examples
+
+```
+> ACL SETUSER alan allkeys +@string +@set -SADD >alanpassword
++OK
+> ACL SETUSER antirez heeyyyy
+(error) ERR Error in ACL SETUSER modifier 'heeyyyy': Syntax error
+```
+
+## Details
+
+### ACL rules
 
 Redis ACL rules are split into two categories: rules that define command permissions or _command rules_, and rules that define the user state or _user management rules_.
 This is a list of all the supported Redis ACL rules:
 
-### Command rules
+#### Command rules
 
 * `~<pattern>`: Adds the specified key pattern (glob style pattern, like in the [`KEYS`]({{< relref "/commands/keys" >}}) command), to the list of key patterns accessible by the user. This grants both read and write permissions to keys that match the pattern. You can add multiple key patterns to the same user. Example: `~objects:*`
 * `%R~<pattern>`: (Available in Redis 7.0 and later) Adds the specified read key pattern. This behaves similar to the regular key pattern but only grants permission to read from keys that match the given pattern. See [key permissions]({{< relref "/operate/oss_and_stack/management/security/acl#key-permissions" >}}) for more information.
@@ -122,7 +149,7 @@ This is a list of all the supported Redis ACL rules:
 * `-@<category>`: Like `+@<category>` but removes all the commands in the category instead of adding them.
 * `nocommands`: Alias for `-@all`. Removes all the commands, and the user is no longer able to execute anything.
 
-### User management rules
+#### User management rules
 
 * `on`: Set the user as active, it will be possible to authenticate as this user using `AUTH <username> <password>`.
 * `off`: Set user as not active, it will be impossible to log as this user. Please note that if a user gets disabled (set to off) after there are connections already authenticated with such a user, the connections will continue to work as expected. To also kill the old connections you can use [`CLIENT KILL`]({{< relref "/commands/client-kill" >}}) with the user option. An alternative is to delete the user with [`ACL DELUSER`]({{< relref "/commands/acl-deluser" >}}), that will result in all the connections authenticated as the deleted user to be disconnected.
@@ -135,16 +162,6 @@ This is a list of all the supported Redis ACL rules:
 * `clearselectors`: (Available in Redis 7.0 and later) Deletes all of the selectors attached to the user.
 * `reset`: Removes any capability from the user. They are set to off, without passwords, unable to execute any command, unable to access any key.
 
-## Examples
-
-```
-> ACL SETUSER alan allkeys +@string +@set -SADD >alanpassword
-+OK
-
-> ACL SETUSER antirez heeyyyy
-(error) ERR Error in ACL SETUSER modifier 'heeyyyy': Syntax error
-```
-
 ## Redis Software and Redis Cloud compatibility
 
 | Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |

content/commands/bgsave.md

@@ -58,6 +58,14 @@ command.
 
 See the [persistence documentation]({{< relref "/operate/oss_and_stack/management/persistence" >}}) for detailed information.
 
+## Optional arguments
+
+<details open><summary><code>SCHEDULE</code></summary>
+
+Schedule the save to run after any in-progress `BGSAVE` finishes, instead of returning an error.
+
+</details>
+
 ## Redis Software and Redis Cloud compatibility
 
 | Redis<br />Software | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |

content/commands/command-docs.md

@@ -47,29 +47,38 @@ The following keys may be included in the mapped reply:
 * **since:** the Redis version that added the command (or for module commands, the module version).
 * **group:** the functional group to which the command belongs.
   Possible values are:
-  - _bitmap_
-  - _cluster_
-  - _connection_
-  - _generic_
-  - _geo_
-  - _hash_
-  - _hyperloglog_
-  - _list_
-  - _module_
-  - _pubsub_
-  - _scripting_
-  - _sentinel_
-  - _server_
-  - _set_
-  - _sorted-set_
-  - _stream_
-  - _string_
-  - _transactions_
+    - array
+    - bf
+    - bitmap
+    - cf
+    - cluster
+    - cms
+    - connection
+    - generic
+    - geo
+    - hash
+    - hyperloglog
+    - json
+    - list
+    - pubsub
+    - scripting
+    - search
+    - server
+    - set
+    - sorted-set
+    - stream
+    - string
+    - suggestion
+    - tdigest
+    - timeseries
+    - topk
+    - transactions
+    - vector_set
 * **complexity:** a short explanation about the command's time complexity.
 * **doc_flags:** an array of documentation flags.
   Possible values are:
-  - _deprecated:_ the command is deprecated.
-  - _syscmd:_ a system command that isn't meant to be called by users.
+  - deprecated: the command is deprecated.
+  - syscmd: a system command that isn't meant to be called by users.
 * **deprecated_since:** the Redis version that deprecated the command (or for module commands, the module version)..
 * **replaced_by:** the alternative for a deprecated command.
 * **history:** an array of historical notes describing changes to the command's output or arguments. It should not contain information about behavioral changes.
@@ -81,6 +90,14 @@ The following keys may be included in the mapped reply:
 
 [td]: /develop/reference/command-arguments
 
+## Optional arguments
+
+<details open><summary><code>command-name [command-name ...]</code></summary>
+
+One or more command names to return documentation for. If omitted, documentation for all commands is returned.
+
+</details>
+
 ## Examples
 
 {{% redis-cli %}}

content/commands/command-getkeys.md

@@ -36,14 +36,28 @@ summary: Extracts the key names from an arbitrary command.
 syntax_fmt: COMMAND GETKEYS command [arg [arg ...]]
 title: COMMAND GETKEYS
 ---
-Returns [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of keys from a full Redis command.
 
 `COMMAND GETKEYS` is a helper command to let you find the keys
-from a full Redis command.
+from the provided Redis `command`.
 
-[`COMMAND`]({{< relref "/commands/command" >}}) provides information on how to find the key names of each command (see `firstkey`, [key specifications]({{< relref "develop/reference/key-specs#logical-operation-flags" >}}), and `movablekeys`),
-but in some cases it's not possible to find keys of certain commands and then the entire command must be parsed to discover some / all key names.
-You can use `COMMAND GETKEYS` or [`COMMAND GETKEYSANDFLAGS`]({{< relref "/commands/command-getkeysandflags" >}}) to discover key names directly from how Redis parses the commands.
+
+[`COMMAND`]({{< relref "/commands/command" >}}) describes how Redis identifies key names for each command, including `firstkey`, [key specifications]({{< relref "develop/reference/key-specs#logical-operation-flags" >}}), and `movablekeys`. For some commands, Redis can identify the keys only by parsing the full command. Use COMMAND GETKEYS or [`COMMAND GETKEYSANDFLAGS`]({{< relref "/commands/command-getkeysandflags" >}}) to get the key names directly from the Redis command parser.
+
+## Required arguments
+
+<details open><summary><code>command</code></summary>
+
+The name of the command to analyze.
+
+</details>
+
+## Optional arguments
+
+<details open><summary><code>arg [arg ...]</code></summary>
+
+The arguments that would be passed to the command.
+
+</details>
 
 ## Examples