RDSC-2986-generate-and-publish-a-swagger-api-web-page-to-be-used-as-reference-from-clients-of-the-rdi-api-update-autogenerated-docs: Auto generated

content/integrate/redis-data-integration/reference/_index.md

@@ -3,15 +3,16 @@ Title: Reference
 aliases: /integrate/redis-data-integration/ingest/reference/
 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

content/integrate/redis-data-integration/reference/api-reference.md

@@ -0,0 +1,24 @@
+---
+Title: Redis Data Integration API Reference
+linkTitle: API Reference
+description: REST API reference for Redis Data Integration
+weight: 20
+alwaysopen: false
+categories: ["redis-di"]
+aliases:
+---
+
+# Redis Data Integration API
+
+This is the REST API reference for Redis Data Integration services.
+The API provides endpoints to manage and monitor your Redis Data Integration deployments.
+
+[Open API Documentation]({{< relref "/integrate/redis-data-intrgration/reference/api/api-reference" >}})
+
+## Authentication
+
+When authentication is enabled, you need to obtain a token using the login endpoint before accessing secured endpoints.
+
+## Base URL
+
+All API endpoints are relative to the base URL of your Redis Data Integration API server.

content/integrate/redis-data-integration/reference/cli/_index.md

@@ -3,15 +3,16 @@ Title: CLI reference
 aliases: /integrate/redis-data-integration/ingest/reference/cli/
 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

content/integrate/redis-data-integration/reference/cli/redis-di-add-context.md

@@ -1,118 +1,100 @@
 ---
 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`
-
-
-
-
-* `log_level`: 
-  * Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']) 
-  * Default: `info`
-  * Usage: `--log-level
--l`
-
-
 
+- `context_name` (REQUIRED):
 
-* `cluster_host` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--cluster-host`
+  - Type: STRING
+  - Default: `none`
+  - Usage: `context-name`
 
-  Host/IP of Redis Enterprise Cluster (service name in case of k8s)
+- `log_level`:
 
+  - Type: Choice(['TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])
+  - Default: `info`
+  - Usage: `--log-level
+-l`
 
-* `cluster_api_port` (REQUIRED): 
-  * Type: <IntRange 1<=x<=65535> 
-  * Default: `9443`
-  * Usage: `--cluster-api-port`
-
-  API Port of Redis Enterprise Cluster
-
+- `rdi_namespace`:
 
-* `cluster_user` (REQUIRED): 
-  * Type: STRING 
-  * Default: `none`
-  * Usage: `--cluster-user`
+  - Type: STRING
+  - Default: `rdi`
+  - Usage: `--rdi-namespace`
 
-  Redis Enterprise Cluster username with either DB Member, Cluster Member or Cluster Admin roles
+  RDI Kubernetes namespace
 
+- `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
 
 ```
@@ -121,16 +103,9 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
   Adds a new context
 
 Options:
-  -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
+  -l, --log-level [TRACE|DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                   [default: INFO]
-  --cluster-host TEXT             Host/IP of Redis Enterprise Cluster (service
-                                  name in case of k8s)  [required]
-  --cluster-api-port INTEGER RANGE
-                                  API Port of Redis Enterprise Cluster
-                                  [default: 9443; 1<=x<=65535; required]
-  --cluster-user TEXT             Redis Enterprise Cluster username with
-                                  either DB Member, Cluster Member or Cluster
-                                  Admin roles  [required]
+  --rdi-namespace TEXT            RDI Kubernetes namespace  [default: rdi]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
   --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]