Update autogenerated docs

redis · Jun 7, 2024 · 90fe122 · 90fe122
1 parent 1ddb308
commit 90fe122
Show file tree

Hide file tree

Showing 30 changed files with 1,595 additions and 904 deletions.
diff --git a/content/integrate/redis-data-integration/ingest/reference/_index.md b/content/integrate/redis-data-integration/ingest/reference/_index.md
@@ -3,15 +3,16 @@ Title: Reference
 aliases: null
 alwaysopen: false
 categories:
-- docs
-- integrate
-- rs
-- rdi
+  - docs
+  - integrate
+  - rs
+  - rdi
 description: View reference material for Redis Data Integration
 group: di
 hideListLinks: false
 linkTitle: Reference
-summary: Redis Data Integration keeps Redis in sync with the primary database in near
+summary:
+  Redis Data Integration keeps Redis in sync with the primary database in near
   real time.
 type: integration
 weight: 60

diff --git a/content/integrate/redis-data-integration/ingest/reference/cli/_index.md b/content/integrate/redis-data-integration/ingest/reference/cli/_index.md
@@ -3,15 +3,16 @@ Title: CLI reference
 aliases: null
 alwaysopen: false
 categories:
-- docs
-- integrate
-- rs
-- rdi
+  - docs
+  - integrate
+  - rs
+  - rdi
 description: Reference for the RDI CLI commands
 group: di
 hideListLinks: false
 linkTitle: CLI commands
-summary: Redis Data Integration keeps Redis in sync with the primary database in near
+summary:
+  Redis Data Integration keeps Redis in sync with the primary database in near
   real time.
 type: integration
 weight: 60

diff --git a/...t/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context.md b/...t/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context.md
@@ -1,118 +1,116 @@
 ---
 Title: redis-di add-context
 linkTitle: redis-di add-context
-description: Adds a new context 
+description: Adds a new context
 weight: 10
 alwaysopen: false
 categories: ["redis-di"]
 aliases:
 ---
 
+Adds a new context
+
 ## Usage
 
 ```
 Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
 ```
 
 ## Options
-* `context_name` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `context-name`
 
-  
+- `context_name` (REQUIRED):
 
+  - Type: STRING
+  - Default: `none`
+  - Usage: `context-name`
 
-* `log_level`: 
-  * Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']) 
-  * Default: `info`
-  * Usage: `--log-level
--l`
+- `log_level`:
 
-
+  - Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
+  - Default: `info`
+  - Usage: `--log-level
+-l`
 
+- `cluster_host` (REQUIRED):
 
-* `cluster_host` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--cluster-host`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--cluster-host`
 
   Host/IP of Redis Enterprise Cluster (service name in case of k8s)
 
+- `cluster_api_port` (REQUIRED):
 
-* `cluster_api_port` (REQUIRED): 
-  * Type: <IntRange 1<=x<=65535> 
-  * Default: `9443`
-  * Usage: `--cluster-api-port`
+  - Type: <IntRange 1<=x<=65535>
+  - Default: `9443`
+  - Usage: `--cluster-api-port`
 
   API Port of Redis Enterprise Cluster
 
+- `cluster_user` (REQUIRED):
 
-* `cluster_user` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--cluster-user`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--cluster-user`
 
   Redis Enterprise Cluster username with either DB Member, Cluster Member or Cluster Admin roles
 
+- `rdi_host` (REQUIRED):
 
-* `rdi_host` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-host`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-host`
 
   Host/IP of RDI Database
 
+- `rdi_port` (REQUIRED):
 
-* `rdi_port` (REQUIRED): 
-  * Type: <IntRange 1<=x<=65535> 
-  * Default: `none`
-  * Usage: `--rdi-port`
+  - Type: <IntRange 1<=x<=65535>
+  - Default: `none`
+  - Usage: `--rdi-port`
 
   Port of RDI Database
 
+- `rdi_user`:
 
-* `rdi_user`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-user`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-user`
 
   RDI Database Username
 
+- `rdi_key`:
 
-* `rdi_key`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-key`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-key`
 
   Private key file to authenticate with
 
+- `rdi_cert`:
 
-* `rdi_cert`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-cert`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-cert`
 
   Client certificate file to authenticate with
 
+- `rdi_cacert`:
 
-* `rdi_cacert`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-cacert`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-cacert`
 
   CA certificate file to verify with
 
+- `help`:
 
-* `help`: 
-  * Type: BOOL 
-  * Default: `false`
-  * Usage: `--help`
+  - Type: BOOL
+  - Default: `false`
+  - Usage: `--help`
 
   Show this message and exit.
 
-
-
 ## CLI help
 
 ```

diff --git a/...nt/integrate/redis-data-integration/ingest/reference/cli/redis-di-config-rdi.md b/...nt/integrate/redis-data-integration/ingest/reference/cli/redis-di-config-rdi.md
@@ -1,102 +1,102 @@
 ---
 Title: redis-di config-rdi
 linkTitle: redis-di config-rdi
-description: Configures RDI DB connection credentials 
+description: Configures RDI db connection credentials
 weight: 10
 alwaysopen: false
 categories: ["redis-di"]
 aliases:
 ---
 
+Configures RDI db connection credentials
+
 ## Usage
 
 ```
 Usage: redis-di config-rdi [OPTIONS]
 ```
 
 ## Options
-* `log_level`: 
-  * Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']) 
-  * Default: `info`
-  * Usage: `--log-level
--l`
 
-
+- `log_level`:
+
+  - Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
+  - Default: `info`
+  - Usage: `--log-level
+-l`
 
+- `rdi_host` (REQUIRED):
 
-* `rdi_host` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-host`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-host`
 
   Host/IP of RDI Database
 
+- `rdi_port` (REQUIRED):
 
-* `rdi_port` (REQUIRED): 
-  * Type: <IntRange 1<=x<=65535> 
-  * Default: `none`
-  * Usage: `--rdi-port`
+  - Type: <IntRange 1<=x<=65535>
+  - Default: `none`
+  - Usage: `--rdi-port`
 
   Port of RDI Database
 
+- `rdi_user`:
 
-* `rdi_user`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-user`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-user`
 
   RDI Database Username
 
+- `rdi_password`:
 
-* `rdi_password`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-password`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-password`
 
   RDI Database Password
 
+- `rdi_key`:
 
-* `rdi_key`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-key`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-key`
 
   Private key file to authenticate with
 
+- `rdi_cert`:
 
-* `rdi_cert`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-cert`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-cert`
 
   Client certificate file to authenticate with
 
+- `rdi_cacert`:
 
-* `rdi_cacert`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-cacert`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-cacert`
 
   CA certificate file to verify with
 
+- `rdi_key_password`:
 
-* `rdi_key_password`: 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--rdi-key-password`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `--rdi-key-password`
 
   Password for unlocking an encrypted private key
 
+- `help`:
 
-* `help`: 
-  * Type: BOOL 
-  * Default: `false`
-  * Usage: `--help`
+  - Type: BOOL
+  - Default: `false`
+  - Usage: `--help`
 
   Show this message and exit.
 
-
-
 ## CLI help
 
 ```