|
72 | 72 | "traceId": "885bef8bbc18649c",
|
73 | 73 | "type": "UNAUTHORIZED_ERROR"
|
74 | 74 | }
|
| 75 | + }, |
| 76 | + "unprocessableEntityError": { |
| 77 | + "summary": "Unprocessable Entity", |
| 78 | + "value": { |
| 79 | + "code": 422, |
| 80 | + "message": "KMS_PARAMS_INVALID", |
| 81 | + "traceId": "885bef8bbc18649c", |
| 82 | + "type": "UNPROCESSABLE_ENTITY_ERROR" |
| 83 | + } |
| 84 | + }, |
| 85 | + "validationError": { |
| 86 | + "summary": "Validation Error", |
| 87 | + "value": { |
| 88 | + "code": 422, |
| 89 | + "validation": [ |
| 90 | + { |
| 91 | + "field": "name", |
| 92 | + "message": "this field is required" |
| 93 | + } |
| 94 | + ] |
| 95 | + } |
75 | 96 | }
|
76 | 97 | },
|
77 | 98 | "parameters": {
|
|
282 | 303 | ],
|
283 | 304 | "type": "object"
|
284 | 305 | },
|
| 306 | + "CreateInstanceUnprocessableEntity": { |
| 307 | + "oneOf": [ |
| 308 | + { |
| 309 | + "$ref": "#/components/schemas/Error" |
| 310 | + }, |
| 311 | + { |
| 312 | + "$ref": "#/components/schemas/ValidationError" |
| 313 | + } |
| 314 | + ] |
| 315 | + }, |
285 | 316 | "CreateUserResponse": {
|
286 | 317 | "properties": {
|
287 | 318 | "connectionString": {
|
|
986 | 1017 | "backupSchedule": {
|
987 | 1018 | "$ref": "#/components/schemas/backup.schedule"
|
988 | 1019 | },
|
| 1020 | + "encryption": { |
| 1021 | + "$ref": "#/components/schemas/instance.encryption" |
| 1022 | + }, |
989 | 1023 | "flavorId": {
|
990 | 1024 | "$ref": "#/components/schemas/flavor.flavorId"
|
991 | 1025 | },
|
992 | 1026 | "name": {
|
993 | 1027 | "$ref": "#/components/schemas/instance.name"
|
994 | 1028 | },
|
| 1029 | + "network": { |
| 1030 | + "$ref": "#/components/schemas/instance.network" |
| 1031 | + }, |
995 | 1032 | "replicas": {
|
996 | 1033 | "$ref": "#/components/schemas/replicas"
|
997 | 1034 | },
|
|
1215 | 1252 | ],
|
1216 | 1253 | "type": "object"
|
1217 | 1254 | },
|
| 1255 | + "instance.encryption": { |
| 1256 | + "description": "The configuration for instance's volume and backup storage encryption.\n\n⚠️ **Note:** This feature is in private preview. Supplying this object is only permitted for enabled accounts. If your account does not have access, the request will be rejected.\n", |
| 1257 | + "properties": { |
| 1258 | + "kekKeyId": { |
| 1259 | + "description": "The encryption-key key identifier", |
| 1260 | + "example": "48e3f816-3e38-44bb-bbff-22e05f0567de", |
| 1261 | + "type": "string", |
| 1262 | + "x-oapi-codegen-extra-tags": { |
| 1263 | + "validate": "required,uuid_rfc4122" |
| 1264 | + } |
| 1265 | + }, |
| 1266 | + "kekKeyRingId": { |
| 1267 | + "description": "The encryption-key keyring identifier", |
| 1268 | + "example": "48e3f816-3e38-44bb-bbff-22e05f0567de", |
| 1269 | + "type": "string", |
| 1270 | + "x-oapi-codegen-extra-tags": { |
| 1271 | + "validate": "required,uuid_rfc4122" |
| 1272 | + } |
| 1273 | + }, |
| 1274 | + "kekKeyVersion": { |
| 1275 | + "description": "The encryption-key version", |
| 1276 | + "example": "1", |
| 1277 | + "type": "string", |
| 1278 | + "x-oapi-codegen-extra-tags": { |
| 1279 | + "validate": "required" |
| 1280 | + } |
| 1281 | + }, |
| 1282 | + "serviceAccount": { |
| 1283 | + |
| 1284 | + "type": "string", |
| 1285 | + "x-oapi-codegen-extra-tags": { |
| 1286 | + "validate": "required,email" |
| 1287 | + } |
| 1288 | + } |
| 1289 | + }, |
| 1290 | + "required": [ |
| 1291 | + "serviceAccount", |
| 1292 | + "kekKeyRingId", |
| 1293 | + "kekKeyId", |
| 1294 | + "kekKeyVersion" |
| 1295 | + ], |
| 1296 | + "type": "object" |
| 1297 | + }, |
1218 | 1298 | "instance.id": {
|
1219 | 1299 | "description": "The ID of the instance.",
|
1220 | 1300 | "example": "df727477-8991-486c-a3ed-d11d9d9beb1c",
|
|
1235 | 1315 | "example": "postgres-instance",
|
1236 | 1316 | "type": "string"
|
1237 | 1317 | },
|
| 1318 | + "instance.network": { |
| 1319 | + "description": "The network configuration of the instance.\n\n⚠️ **Note:** This feature is in private preview. Supplying this object is only permitted for enabled accounts. If your account does not have access, the request will be rejected.\n", |
| 1320 | + "properties": { |
| 1321 | + "accessScope": { |
| 1322 | + "default": "PUBLIC", |
| 1323 | + "description": "The access scope of the instance. It defines if the instance is public or airgapped.", |
| 1324 | + "enum": [ |
| 1325 | + "PUBLIC", |
| 1326 | + "SNA" |
| 1327 | + ], |
| 1328 | + "type": "string", |
| 1329 | + "x-enum-descriptions": [ |
| 1330 | + "defines networking for a public instance", |
| 1331 | + "defines networking for a private instance" |
| 1332 | + ], |
| 1333 | + "x-oapi-codegen-extra-tags": { |
| 1334 | + "validate": "omitempty,oneof=PUBLIC SNA,instance_accessScope" |
| 1335 | + } |
| 1336 | + } |
| 1337 | + }, |
| 1338 | + "required": [ |
| 1339 | + "accessScope" |
| 1340 | + ], |
| 1341 | + "type": "object" |
| 1342 | + }, |
1238 | 1343 | "instance.sort": {
|
1239 | 1344 | "enum": [
|
1240 | 1345 | "index.desc",
|
|
1267 | 1372 | "type": "object"
|
1268 | 1373 | },
|
1269 | 1374 | "instance.version": {
|
1270 |
| - "description": "The Postgres version used for the instance. See [Versions Endpoint](/v3alpha1/projects/{projectId}/regions/{region}/versions) for supported version parameters.", |
| 1375 | + "description": "The Postgres version used for the instance. See [Versions Endpoint](/documentation/postgres-flex-service/version/v3alpha1#tag/Version) for supported version parameters.", |
1271 | 1376 | "type": "string"
|
1272 | 1377 | },
|
1273 | 1378 | "instance.version.update": {
|
1274 |
| - "description": "The Postgres version used for the instance. See [Versions Endpoint](/v3alpha1/projects/{projectId}/regions/{region}/versions) for supported version parameters.", |
| 1379 | + "description": "The Postgres version used for the instance. See [Versions Endpoint](/documentation/postgres-flex-service/version/v3alpha1#tag/Version) for supported version parameters.", |
1275 | 1380 | "type": "string"
|
1276 | 1381 | },
|
1277 | 1382 | "instance.version.update.opt": {
|
1278 |
| - "description": "The Postgres version used for the instance. See [Versions Endpoint](/v3alpha1/projects/{projectId}/regions/{region}/versions) for supported version parameters.", |
| 1383 | + "description": "The Postgres version used for the instance. See [Versions Endpoint](/documentation/postgres-flex-service/version/v3alpha1#tag/Version) for supported version parameters.", |
1279 | 1384 | "type": "string"
|
1280 | 1385 | },
|
1281 | 1386 | "pointInTimeRecoveryRequestPayload": {
|
|
2034 | 2139 | "422": {
|
2035 | 2140 | "content": {
|
2036 | 2141 | "application/json": {
|
| 2142 | + "examples": { |
| 2143 | + "unprocessableEntityError": { |
| 2144 | + "$ref": "#/components/examples/unprocessableEntityError" |
| 2145 | + }, |
| 2146 | + "validationError": { |
| 2147 | + "$ref": "#/components/examples/validationError" |
| 2148 | + } |
| 2149 | + }, |
2037 | 2150 | "schema": {
|
2038 |
| - "$ref": "#/components/schemas/ValidationError" |
| 2151 | + "$ref": "#/components/schemas/CreateInstanceUnprocessableEntity" |
2039 | 2152 | }
|
2040 | 2153 | }
|
2041 | 2154 | },
|
2042 |
| - "description": "Request failed due to body validation" |
| 2155 | + "description": "Unprocessable entity" |
2043 | 2156 | },
|
2044 | 2157 | "500": {
|
2045 | 2158 | "content": {
|
|
0 commit comments