Add do_settings.service_cnames support to Databases API (#1137)

This change adds support for custom service CNAMEs (do_settings.service_cnames)
to the Managed Databases API for both cluster creation and read replica creation.

Changes:
- Add new do_settings.yml model with service_cnames array field
- Add do_settings field to database_cluster and database_cluster_read models
- Add do_settings field to database_replica and database_replica_read models
- Update databases_create_cluster.yml with example using service_cnames
- Update databases_create_replica.yml with example using service_cnames
- Update response examples to include do_settings
- Update curl, Go, and Python code examples

The service_cnames field allows users to specify custom CNAMEs for their
database clusters. Each CNAME must be a valid RFC 1123 hostname (e.g.,
"db.example.com"), with a maximum of 16 CNAMEs allowed, each up to 253
characters in length.

Author: lprasanth-nadiminti

specification/resources/databases/databases_create_cluster.yml

@@ -94,6 +94,22 @@ requestBody:
             size: db-s-2vcpu-4gb
             num_nodes: 2
 
+        Create a New Database Cluster with service CNAMEs:
+          value:
+            name: backend
+            engine: pg
+            version: "14"
+            region: nyc3
+            size: db-s-2vcpu-4gb
+            num_nodes: 2
+            storage_size_mib: 61440
+            tags:
+              - production
+            do_settings:
+              service_cnames:
+                - "db.example.com"
+                - "database.myapp.io"
+
 responses:
   "201":
     $ref: "responses/database_cluster.yml"

specification/resources/databases/databases_create_replica.yml

@@ -34,11 +34,24 @@ requestBody:
           - name
           - size
 
-      example:
-        name: read-nyc3-01
-        region: nyc3
-        size: db-s-2vcpu-4gb
-        storage_size_mib: 61440
+      examples:
+        Create a Read-only Replica:
+          value:
+            name: read-nyc3-01
+            region: nyc3
+            size: db-s-2vcpu-4gb
+            storage_size_mib: 61440
+
+        Create a Read-only Replica with service CNAMEs:
+          value:
+            name: read-nyc3-01
+            region: nyc3
+            size: db-s-2vcpu-4gb
+            storage_size_mib: 61440
+            do_settings:
+              service_cnames:
+                - "replica-db.example.com"
+                - "read-replica.myapp.io"
 
 responses:
   '201':

specification/resources/databases/examples/curl/databases_create_cluster.yml

@@ -3,5 +3,5 @@ source: |-
   curl -X POST \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
-    -d '{"name": "backend", "engine": "pg", "version": "14", "region": "nyc3", "size": "db-s-2vcpu-4gb", "num_nodes": 2, "storage_size_mib": 61440, "tags": ["production"]}' \
+    -d '{"name": "backend", "engine": "pg", "version": "14", "region": "nyc3", "size": "db-s-2vcpu-4gb", "num_nodes": 2, "storage_size_mib": 61440, "tags": ["production"], "do_settings": {"service_cnames": ["db.example.com", "database.myapp.io"]}}' \
     "https://api.digitalocean.com/v2/databases"

specification/resources/databases/examples/curl/databases_create_replica.yml

@@ -3,5 +3,5 @@ source: |-
   curl -X POST \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
-    -d '{"name":"read-nyc3-01", "region":"nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440}' \
+    -d '{"name":"read-nyc3-01", "region":"nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440, "do_settings": {"service_cnames": ["replica-db.example.com", "read-replica.myapp.io"]}}' \
     "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/replicas"

specification/resources/databases/examples/go/databases_create_cluster.yml

@@ -21,6 +21,9 @@ source: |-
           SizeSlug:   "db-s-2vcpu-4gb",
           NumNodes:   2,
           StorageSizeMiB : 61440,
+          DOSettings: &godo.DOSettings{
+              ServiceCnames: []string{"db.example.com", "database.myapp.io"},
+          },
       }
 
       cluster, _, err := client.Databases.Create(ctx, createRequest)

specification/resources/databases/examples/go/databases_create_replica.yml

@@ -14,11 +14,13 @@ source: |-
       ctx := context.TODO()
 
       replicaRequest := &godo.DatabaseCreateReplicaRequest{
-
           Name:   "read-nyc3-01",
           Region: "nyc3",
           Size:   "db-s-2vcpu-4gb",
-          StorageSizeMiB : 61440,
+          StorageSizeMiB: 61440,
+          DOSettings: &godo.DOSettings{
+              ServiceCnames: []string{"replica-db.example.com", "read-replica.myapp.io"},
+          },
       }
 
       replica, _, err := client.Databases.CreateReplica(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", replicaRequest)

specification/resources/databases/examples/python/databases_create_cluster.yml

@@ -15,7 +15,13 @@ source: |-
     "storage_size_mib": 61440,
     "tags": [
       "production"
-    ]
+    ],
+    "do_settings": {
+      "service_cnames": [
+        "db.example.com",
+        "database.myapp.io"
+      ]
+    }
   }
 
   create_resp = client.databases.create_cluster(body=create_req)

specification/resources/databases/examples/python/databases_create_replica.yml

@@ -10,6 +10,12 @@ source: |-
     "region": "nyc3",
     "size": "db-s-2vcpu-4gb",
     "storage_size_mib": 61440,
+    "do_settings": {
+      "service_cnames": [
+        "replica-db.example.com",
+        "read-replica.myapp.io"
+      ]
+    }
   }
 
   create_resp = client.databases.create_replica(database_cluster_uuid="9cc10173", body=create_req)

specification/resources/databases/models/database_cluster.yml

@@ -177,6 +177,11 @@ properties:
     description: >-
       Autoscaling configuration for the database cluster. Currently only supports storage autoscaling. If null, autoscaling is
       not configured for the cluster.
+  do_settings:
+    allOf:
+    - $ref: './do_settings.yml'
+    - description: >-
+        DigitalOcean-specific settings for the database cluster, including custom service CNAMEs.
 
 
 

specification/resources/databases/models/database_cluster_read.yml

@@ -171,6 +171,11 @@ properties:
       Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and
       a second entry for the cluster's standby node(s).
     readOnly: true
+  do_settings:
+    allOf:
+    - $ref: './do_settings.yml'
+    - description: >-
+        DigitalOcean-specific settings for the database cluster, including custom service CNAMEs.