DBAAS-5458: Update API documentation for Redis (#1063)

jmestizo · SSharma-10 · web-flow · commit 3e0e5faaaff6 · 2025-08-04T17:36:48.000+05:30
Change the name 'Redis' to 'Caching'.

Co-authored-by: SSharma-10 &lt;shivanisharma@digitalocean.com&gt;
diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml
@@ -153,7 +153,7 @@ tags:
       DigitalOcean's [managed database service](https://docs.digitalocean.com/products/databases)
       simplifies the creation and management of highly available database clusters. Currently, it
       offers support for [PostgreSQL](http://docs.digitalocean.com/products/databases/postgresql/),
-      [Redis](https://docs.digitalocean.com/products/databases/redis/),
+      [Caching](https://docs.digitalocean.com/products/databases/redis/),
       [Valkey](https://docs.digitalocean.com/products/databases/valkey/),
       [MySQL](https://docs.digitalocean.com/products/databases/mysql/),
       [MongoDB](https://docs.digitalocean.com/products/databases/mongodb/), and
diff --git a/specification/resources/apps/models/app_database_spec.yml b/specification/resources/apps/models/app_database_spec.yml
@@ -33,7 +33,7 @@ properties:
     description: |-
       - MYSQL: MySQL
       - PG: PostgreSQL
-      - REDIS: Redis
+      - REDIS: Caching
       - MONGODB: MongoDB
       - KAFKA: Kafka
       - OPENSEARCH: OpenSearch
diff --git a/specification/resources/databases/databases_add.yml b/specification/resources/databases/databases_add.yml
@@ -6,7 +6,7 @@ description: |
   To add a new database to an existing cluster, send a POST request to
   `/v2/databases/$DATABASE_ID/dbs`.
 
-  Note: Database management is not supported for Redis or Valkey clusters.
+  Note: Database management is not supported for Caching or Valkey clusters.
 
   The response will be a JSON object with a key called `db`. The value of this will be
   an object that contains the standard attributes associated with a database.
diff --git a/specification/resources/databases/databases_add_user.yml b/specification/resources/databases/databases_add_user.yml
@@ -6,7 +6,7 @@ description: |
   To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users`
   with the desired username.
 
-  Note: User management is not supported for Redis or Valkey clusters.
+  Note: User management is not supported for Caching or Valkey clusters.
 
   When adding a user to a MySQL cluster, additional options can be configured in the
   `mysql_settings` object.
diff --git a/specification/resources/databases/databases_create_cluster.yml b/specification/resources/databases/databases_create_cluster.yml
@@ -30,8 +30,8 @@ description: >-
   database cluster and the timestamp of the backup to be restored. Creating a database
   from a backup is the same as forking a database in the control panel.
 
-  Note: Redis cluster creates are no longer supported as of 2025-04-30T00:00:00Z. 
-  Backups are also not supported for Redis or Valkey clusters.
+  Note: Caching cluster creates are no longer supported as of 2025-04-30T00:00:00Z.
+  Backups are also not supported for Caching or Valkey clusters.
 
 tags:
   - Databases
diff --git a/specification/resources/databases/databases_create_replica.yml b/specification/resources/databases/databases_create_replica.yml
@@ -9,7 +9,7 @@ description: >-
   where it will be located.
 
 
-  **Note**: Read-only replicas are not supported for Redis or Valkey clusters.
+  **Note**: Read-only replicas are not supported for Caching or Valkey clusters.
 
 
   The response will be a JSON object with a key called `replica`. The value of
diff --git a/specification/resources/databases/databases_delete.yml b/specification/resources/databases/databases_delete.yml
@@ -9,7 +9,7 @@ description: |
   A status of 204 will be given. This indicates that the request was processed
   successfully, but that no response body is needed.
 
-  Note: Database management is not supported for Redis or Valkey clusters.
+  Note: Database management is not supported for Caching or Valkey clusters.
 
 tags:
   - Databases
diff --git a/specification/resources/databases/databases_delete_user.yml b/specification/resources/databases/databases_delete_user.yml
@@ -9,7 +9,7 @@ description: |
   A status of 204 will be given. This indicates that the request was processed
   successfully, but that no response body is needed.
 
-  Note: User management is not supported for Redis or Valkey clusters.
+  Note: User management is not supported for Caching or Valkey clusters.
 
 tags:
   - Databases
diff --git a/specification/resources/databases/databases_destroy_replica.yml b/specification/resources/databases/databases_destroy_replica.yml
@@ -7,7 +7,7 @@ description: >-
   `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.
 
 
-  **Note**: Read-only replicas are not supported for Redis or Valkey clusters.
+  **Note**: Read-only replicas are not supported for Caching or Valkey clusters.
 
 
   A status of 204 will be given. This indicates that the request was processed
diff --git a/specification/resources/databases/databases_get.yml b/specification/resources/databases/databases_get.yml
@@ -6,7 +6,7 @@ description: |
   To show information about an existing database cluster, send a GET request to
   `/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.
 
-  Note: Database management is not supported for Redis or Valkey clusters.
+  Note: Database management is not supported for Caching or Valkey clusters.
 
   The response will be a JSON object with a `db` key. This will be set to an object
   containing the standard database attributes.
diff --git a/specification/resources/databases/databases_get_evictionPolicy.yml b/specification/resources/databases/databases_get_evictionPolicy.yml
@@ -1,9 +1,9 @@
 operationId: databases_get_evictionPolicy
 
-summary: Retrieve the Eviction Policy for a Redis or Valkey Cluster
+summary: Retrieve the Eviction Policy for a Caching or Valkey Cluster
 
 description: >-
-  To retrieve the configured eviction policy for an existing Redis or Valkey cluster,
+  To retrieve the configured eviction policy for an existing Caching or Valkey cluster,
   send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`.
 
   The response will be a JSON object with an `eviction_policy` key. This will
diff --git a/specification/resources/databases/databases_get_replica.yml b/specification/resources/databases/databases_get_replica.yml
@@ -7,7 +7,7 @@ description: >-
   to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.
 
 
-  **Note**: Read-only replicas are not supported for Redis or Valkey clusters.
+  **Note**: Read-only replicas are not supported for Caching or Valkey clusters.
 
 
   The response will be a JSON object with a `replica key`. This will be set to
diff --git a/specification/resources/databases/databases_get_user.yml b/specification/resources/databases/databases_get_user.yml
@@ -6,7 +6,7 @@ description: |
   To show information about an existing database user, send a GET request to
   `/v2/databases/$DATABASE_ID/users/$USERNAME`.
 
-  Note: User management is not supported for Redis or Valkey clusters.
+  Note: User management is not supported for Caching or Valkey clusters.
 
   The response will be a JSON object with a `user` key. This will be set to an object
   containing the standard database user attributes. The user's password will not show
diff --git a/specification/resources/databases/databases_list.yml b/specification/resources/databases/databases_list.yml
@@ -9,7 +9,7 @@ description: |
   The result will be a JSON object with a `dbs` key. This will be set to an array
   of database objects, each of which will contain the standard database attributes.
 
-  Note: Database management is not supported for Redis or Valkey clusters.
+  Note: Database management is not supported for Caching or Valkey clusters.
 
 tags:
   - Databases
diff --git a/specification/resources/databases/databases_list_backups.yml b/specification/resources/databases/databases_list_backups.yml
@@ -6,7 +6,7 @@ description: >-
   To list all of the available backups of a PostgreSQL or MySQL database
   cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`.
 
-  **Note**: Backups are not supported for Redis or Valkey clusters.
+  **Note**: Backups are not supported for Caching or Valkey clusters.
 
   The result will be a JSON object with a `backups key`. This will be set to
   an array of backup objects, each of which will contain the size of the
diff --git a/specification/resources/databases/databases_list_replicas.yml b/specification/resources/databases/databases_list_replicas.yml
@@ -7,7 +7,7 @@ description: >-
   send a GET request to `/v2/databases/$DATABASE_ID/replicas`.
 
 
-  **Note**: Read-only replicas are not supported for Redis or Valkey clusters.
+  **Note**: Read-only replicas are not supported for Caching or Valkey clusters.
 
 
   The result will be a JSON object with a `replicas` key. This will be set to
diff --git a/specification/resources/databases/databases_list_users.yml b/specification/resources/databases/databases_list_users.yml
@@ -6,7 +6,7 @@ description: |
   To list all of the users for your database cluster, send a GET request to
   `/v2/databases/$DATABASE_ID/users`.
 
-  Note: User management is not supported for Redis or Valkey clusters.
+  Note: User management is not supported for Caching or Valkey clusters.
 
   The result will be a JSON object with a `users` key. This will be set to an array
   of database user objects, each of which will contain the standard database user attributes.
diff --git a/specification/resources/databases/databases_promote_replica.yml b/specification/resources/databases/databases_promote_replica.yml
@@ -7,7 +7,7 @@ description: >-
   `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`.
 
 
-  **Note**: Read-only replicas are not supported for Redis or Valkey clusters.
+  **Note**: Read-only replicas are not supported for Caching or Valkey clusters.
 
 
   A status of 204 will be given. This indicates that the request was processed
diff --git a/specification/resources/databases/databases_update_evictionPolicy.yml b/specification/resources/databases/databases_update_evictionPolicy.yml
@@ -1,9 +1,9 @@
 operationId: databases_update_evictionPolicy
 
-summary: Configure the Eviction Policy for a Redis or Valkey Cluster
+summary: Configure the Eviction Policy for a Caching or Valkey Cluster
 
 description: >-
-  To configure an eviction policy for an existing Redis or Valkey cluster, send a PUT
+  To configure an eviction policy for an existing Caching or Valkey cluster, send a PUT
   request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the
   desired policy.
 
diff --git a/specification/resources/databases/databases_update_onlineMigration.yml b/specification/resources/databases/databases_update_onlineMigration.yml
@@ -7,13 +7,13 @@ description: >-
   `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster
   establishes a connection with an existing cluster and replicates its
   contents to the target cluster. Online migration is only available for
-  MySQL, PostgreSQL, Redis, and Valkey clusters.
+  MySQL, PostgreSQL, Caching, and Valkey clusters.
 
   If the existing database is continuously being written to, 
   the migration process will continue for up to two weeks unless it is manually stopped. Online migration is only available for
   [MySQL](https://docs.digitalocean.com/products/databases/mysql/how-to/migrate/#:~:text=To%20migrate%20a%20MySQL%20database,then%20select%20Set%20Up%20Migration), 
   [PostgreSQL](https://docs.digitalocean.com/products/databases/postgresql/how-to/migrate/), 
-  [Redis](https://docs.digitalocean.com/products/databases/redis/how-to/migrate/), and
+  [Caching](https://docs.digitalocean.com/products/databases/redis/how-to/migrate/), and
   [Valkey](https://docs.digitalocean.com/products/databases/valkey/how-to/migrate/) clusters. 
 
 tags:
diff --git a/specification/resources/databases/models/advanced_config/redis_advanced_config.yml b/specification/resources/databases/models/advanced_config/redis_advanced_config.yml
@@ -11,7 +11,7 @@ properties:
       - volatile-random
       - volatile-ttl
     description: |2-
-      A string specifying the desired eviction policy for the Redis cluster.
+      A string specifying the desired eviction policy for the Caching cluster.
 
       - `noeviction`: Don't evict any data, returns error when memory limit is reached.
       - `allkeys-lru:` Evict any key, least recently used (LRU) first.
@@ -38,7 +38,7 @@ properties:
       service.
     example: 16
   redis_io_threads:
-    description: Redis IO thread count
+    description: Caching IO thread count
     type: integer
     minimum: 1
     maximum: 32
@@ -61,14 +61,14 @@ properties:
     example: 1
   redis_ssl:
     description: |
-      Require SSL to access Redis.
-      - When enabled, Redis accepts only SSL connections on port `25061`.
+      Require SSL to access Caching.
+      - When enabled, Caching accepts only SSL connections on port `25061`.
       - When disabled, port `25060` is opened for non-SSL connections, while port `25061` remains available for SSL connections.
     type: boolean
     default: true
     example: true
   redis_timeout:
-    description: Redis idle connection timeout in seconds
+    description: Caching idle connection timeout in seconds
     type: integer
     minimum: 0
     maximum: 31536000
@@ -118,6 +118,6 @@ properties:
     description: >-
       Determines default pub/sub channels' ACL for new users if ACL is not
       supplied. When this option is not defined, all_channels is assumed to keep
-      backward compatibility. This option doesn't affect Redis configuration
+      backward compatibility. This option doesn't affect Caching configuration
       acl-pubsub-default.
     example: allchannels
diff --git a/specification/resources/databases/models/database_cluster.yml b/specification/resources/databases/models/database_cluster.yml
@@ -24,7 +24,7 @@ properties:
       - opensearch
     description: >-
       A slug representing the database engine used for the cluster. The possible values
-      are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB,
+      are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB,
       "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey.
   version:
     type: string
diff --git a/specification/resources/databases/models/database_cluster_read.yml b/specification/resources/databases/models/database_cluster_read.yml
@@ -24,7 +24,7 @@ properties:
       - opensearch
     description: >-
       A slug representing the database engine used for the cluster. The possible values
-      are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB,
+      are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB,
       "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey.
   version:
     type: string
diff --git a/specification/resources/databases/models/eviction_policy_model.yml b/specification/resources/databases/models/eviction_policy_model.yml
@@ -7,7 +7,7 @@ enum:
   - volatile_random
   - volatile_ttl
 description: |2-
-  A string specifying the desired eviction policy for a Redis or Valkey cluster.
+  A string specifying the desired eviction policy for a Caching or Valkey cluster.
 
   - `noeviction`: Don't evict any data, returns error when memory limit is reached.
   - `allkeys_lru:` Evict any key, least recently used (LRU) first.
