Skip to content

Commit c5cceef

Browse files
authored
openapi spec for advanced_pg + advanced_mysql (#1167)
* openapi spec for advanced_pg + advanced_mysql * openapi spec for advanced_pg + advanced_mysql * add atl1 * remove duplicate examples * address feedback * update description details
1 parent ceb93ca commit c5cceef

5 files changed

Lines changed: 290 additions & 2 deletions

File tree

specification/resources/databases/databases_create_cluster.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,17 @@ description: >-
3030
database cluster and the timestamp of the backup to be restored. Creating a database
3131
from a backup is the same as forking a database in the control panel.
3232
33+
34+
PostgreSQL and MySQL Advanced Edition clusters can be provisioned by setting `engine` to
35+
`advanced_pg` or `advanced_mysql`. Advanced Edition clusters are currently in public
36+
preview and target highly available workloads. `advanced_pg` supports 1-, 2-, and
37+
3-node deployments; `advanced_mysql` only supports 1- and 3-node deployments. See the
38+
[PostgreSQL Advanced Edition](https://docs.digitalocean.com/products/databases/postgresql/how-to/use-advanced-edition-clusters/)
39+
and
40+
[MySQL Advanced Edition](https://docs.digitalocean.com/products/databases/mysql/how-to/use-advanced-edition-clusters/)
41+
documentation for the feature differences vs. Standard Edition and current preview limitations.
42+
43+
3344
Note: Caching cluster creates are no longer supported as of 2025-04-30T00:00:00Z.
3445
Backups are also not supported for Caching or Valkey clusters.
3546
@@ -110,6 +121,42 @@ requestBody:
110121
- "db.example.com"
111122
- "database.myapp.io"
112123

124+
Create a New PostgreSQL Advanced Edition Cluster:
125+
value:
126+
name: backend-advanced
127+
engine: advanced_pg
128+
version: "18"
129+
region: nyc3
130+
size: db-s-2vcpu-4gb
131+
num_nodes: 3
132+
storage_size_mib: 61440
133+
tags:
134+
- production
135+
136+
Create a New MySQL Advanced Edition Cluster:
137+
value:
138+
name: backend-advanced
139+
engine: advanced_mysql
140+
version: "8.4.8"
141+
region: nyc3
142+
size: db-s-2vcpu-4gb
143+
num_nodes: 3
144+
storage_size_mib: 61440
145+
tags:
146+
- production
147+
148+
Create a Single-Node MySQL Advanced Edition Cluster:
149+
value:
150+
name: backend-advanced-single
151+
engine: advanced_mysql
152+
version: "8.4.8"
153+
region: nyc3
154+
size: db-s-2vcpu-4gb
155+
num_nodes: 1
156+
storage_size_mib: 61440
157+
tags:
158+
- production
159+
113160
responses:
114161
"201":
115162
$ref: "responses/database_cluster.yml"

specification/resources/databases/models/database_cluster.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ properties:
2222
- mongodb
2323
- kafka
2424
- opensearch
25+
- advanced_pg
26+
- advanced_mysql
2527
description: >-
2628
A slug representing the database engine used for the cluster. The possible values
2729
are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB,
28-
"kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey.
30+
"kafka" for Kafka, "opensearch" for OpenSearch, "valkey" for Valkey, "advanced_pg" for
31+
PostgreSQL Advanced Edition, and "advanced_mysql" for MySQL Advanced Edition. Advanced
32+
Edition engines are currently in public preview.
2933
version:
3034
type: string
3135
example: '8'

specification/resources/databases/models/database_cluster_read.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ properties:
2222
- mongodb
2323
- kafka
2424
- opensearch
25+
- advanced_pg
26+
- advanced_mysql
2527
description: >-
2628
A slug representing the database engine used for the cluster. The possible values
2729
are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB,
28-
"kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey.
30+
"kafka" for Kafka, "opensearch" for OpenSearch, "valkey" for Valkey, "advanced_pg" for
31+
PostgreSQL Advanced Edition, and "advanced_mysql" for MySQL Advanced Edition. Advanced
32+
Edition engines are currently in public preview.
2933
version:
3034
type: string
3135
example: '8'

specification/resources/databases/models/options.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ properties:
3939
- $ref: "./database_region_options.yml"
4040
- $ref: "./database_version_options.yml"
4141
- $ref: "./database_layout_options.yml"
42+
advanced_pg:
43+
allOf:
44+
- $ref: "./database_region_options.yml"
45+
- $ref: "./database_version_options.yml"
46+
- $ref: "./database_layout_options.yml"
47+
advanced_mysql:
48+
allOf:
49+
- $ref: "./database_region_options.yml"
50+
- $ref: "./database_version_options.yml"
51+
- $ref: "./database_layout_options.yml"
4252
version_availability:
4353
type: object
4454
properties:
@@ -56,3 +66,7 @@ properties:
5666
$ref: "./database_version_availabilities.yml"
5767
opensearch:
5868
$ref: "./database_version_availabilities.yml"
69+
advanced_pg:
70+
$ref: "./database_version_availabilities.yml"
71+
advanced_mysql:
72+
$ref: "./database_version_availabilities.yml"

0 commit comments

Comments
 (0)