Skip to content

Commit 1b2b6ae

Browse files
bbiggerrbbiggerr
authored
Merge pull request #621 from linode/release-4.120.0
Release 4.120.0
2 parents 1f39ea7 + d736c39 commit 1b2b6ae

File tree

1 file changed

+229
-21
lines changed

1 file changed

+229
-21
lines changed

‎openapi.yaml

Lines changed: 229 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.119.4
3+
version: 4.120.0
44

55
title: Linode API
66
description: |
@@ -2047,13 +2047,7 @@ paths:
20472047
- Account
20482048
summary: PayPal Payment Stage
20492049
description: |
2050-
This begins the process of submitting a Payment via PayPal. After calling
2051-
this endpoint, you must take the resulting `payment_id` along with
2052-
the `payer_id` from your PayPal account and
2053-
[POST /account/payments/paypal-execute](/docs/api/account/#stagedapproved-paypal-payment-execute)
2054-
to complete the Payment.
2055-
2056-
**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
2050+
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
20572051
designated as a Payment Method for automated payments using
20582052
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
20592053
operationId: createPayPalPayment
@@ -2121,12 +2115,8 @@ paths:
21212115
- Account
21222116
summary: Staged/Approved PayPal Payment Execute
21232117
description: |
2124-
Given a PaymentID and PayerID - as generated by PayPal during the
2125-
transaction authorization process - this endpoint executes the Payment
2126-
to capture the funds and credit your Linode Account.
2127-
2128-
**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
2129-
designated as a Payment Method for automated or manual payments using
2118+
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2119+
designated as a Payment Method for automated payments using
21302120
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
21312121
operationId: executePayPalPayment
21322122
x-linode-cli-action: paypal-execute
@@ -3282,7 +3272,17 @@ paths:
32823272
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
32833273
* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.
32843274

3285-
All Managed Databases include automatic, daily backups. Up to seven backups are stored for each Managed Database, providing restore points for each day of the past week.
3275+
All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.
3276+
3277+
All Managed Databases include automatic patch updates.
3278+
3279+
* By default, the maintenance window is set to start *every week* on *Sunday* at *20:00 UTC* and lasts for 3 hours.
3280+
3281+
* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3282+
3283+
* Currently, these automatic updates do not include major releases for the database engine software (DBMS). To upgrade to a new major version (such as upgrading MySQL 8.0.26 to 9.0.0), consider deploying a new Managed Database with your preferred version. Then, once it's deployed, you can [migrate your database](/docs/products/databases/managed-databases/guides/migrate-mysql/).
3284+
3285+
* To modify update the maintenance window for a Database, use the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.
32863286

32873287
**Beta**: This endpoint is in **open** beta. During the beta period, Managed Databases will not incur any charges.
32883288
If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the
@@ -3459,6 +3459,14 @@ paths:
34593459
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
34603460
* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.
34613461

3462+
All Managed Databases include automatic patch updates. The maintenance window for these updates is configured with the Managed Database `updates` property.
3463+
3464+
* By default, the maintenance window is set to start *every week* on *Sunday* at *20:00 UTC* and lasts for 3 hours.
3465+
3466+
* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3467+
3468+
* Currently, these automatic updates do not include major releases for the database engine software (DBMS). To upgrade to a new major version (such as upgrading MySQL 8.0.26 to 9.0.0), consider deploying a new Managed Database with your preferred version. Then, once it's deployed, you can [migrate your database](/docs/products/databases/managed-databases/guides/migrate-mysql/).
3469+
34623470
**Beta**: This endpoint is in **open** beta. During the beta period, Managed Databases will not incur any charges.
34633471
If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the
34643472
GA (general availability) release.
@@ -3481,6 +3489,8 @@ paths:
34813489
$ref: '#/components/schemas/DatabaseMySQLRequest/properties/label'
34823490
allow_list:
34833491
$ref: '#/components/schemas/DatabaseMySQLRequest/properties/allow_list'
3492+
updates:
3493+
$ref: '#/components/schemas/DatabaseMySQLRequest/properties/updates'
34843494
responses:
34853495
'200':
34863496
description: Managed Database updated successfully.
@@ -3500,15 +3510,27 @@ paths:
35003510
"allow_list": [
35013511
"203.0.113.1",
35023512
"192.0.1.0/24"
3503-
]
3513+
],
3514+
"updates" = {
3515+
"frequency": "monthly",
3516+
"duration": 3,
3517+
"hour_of_day": 12,
3518+
"day_of_week": 4,
3519+
"week_of_month": 3,
3520+
}
35043521
}' \
35053522
https://api.linode.com/v4beta/databases/mysql/instances/123
35063523
- lang: CLI
35073524
source: >
35083525
linode-cli databases mysql-update 123 \
35093526
--label example-db \
35103527
--allow_list 203.0.113.1 \
3511-
--allow_list 192.0.1.0/24
3528+
--allow_list 192.0.1.0/24 \
3529+
--updates.frequency monthly \
3530+
--updates.duration 3 \
3531+
--updates.hour_of_day 12 \
3532+
--updates.day_of_week 4 \
3533+
--updates.week_of_month 3
35123534
/databases/mysql/instances/{instanceId}/backups:
35133535
x-linode-cli-command: databases
35143536
parameters:
@@ -3534,9 +3556,9 @@ paths:
35343556

35353557
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
35363558

3537-
At this time, only automatically scheduled backups (type `auto`) are available.
3559+
Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.
35383560

3539-
Database backups are created every 24 hours at 0:00 UTC. Each backup is retained for 7 days.
3561+
Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
35403562

35413563
**Beta**: This endpoint is in **open** beta. During the beta period, Managed Databases will not incur any charges.
35423564
If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the
@@ -3571,6 +3593,87 @@ paths:
35713593
- lang: CLI
35723594
source: >
35733595
linode-cli databases mysql-backups-list 123
3596+
post:
3597+
tags:
3598+
- Databases
3599+
summary: Managed MySQL Database Backup Snapshot Create
3600+
operationId: postDatabasesMySQLInstanceBackup
3601+
servers:
3602+
- url: https://api.linode.com/v4beta
3603+
x-linode-cli-action: mysql-backup-snapshot
3604+
x-linode-grant: unrestricted only
3605+
description: |
3606+
Creates a snapshot backup of a Managed MySQL Database.
3607+
3608+
Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.
3609+
3610+
The Database must have an `active` status to perform this command.
3611+
3612+
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3613+
3614+
**Beta**: This endpoint is in **open** beta. During the beta period, Managed Databases will not incur any charges.
3615+
If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the
3616+
GA (general availability) release.
3617+
When accessing this endpoint, please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be
3618+
aware that this endpoint may receive breaking updates in the future. This notice will be removed when this
3619+
endpoint is out of beta.
3620+
security:
3621+
- personalAccessToken: []
3622+
- oauth: []
3623+
requestBody:
3624+
description: Information about the snapshot backup to create.
3625+
content:
3626+
application/json:
3627+
schema:
3628+
required:
3629+
- label
3630+
type: object
3631+
properties:
3632+
label:
3633+
type: string
3634+
minLength: 3
3635+
maxLength: 64
3636+
description: |
3637+
The label for the Database snapshot backup.
3638+
3639+
* Must use only letters, numbers, underscores, dashes, and periods.
3640+
* Must begin and end with a letter or number.
3641+
* Must not include two dashes, underscores, or periods in a row.
3642+
example: db-snapshot
3643+
target:
3644+
type: string
3645+
enum:
3646+
- primary
3647+
- secondary
3648+
default: primary
3649+
description: |
3650+
The Database cluster target.
3651+
3652+
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
3653+
example: primary
3654+
responses:
3655+
'200':
3656+
description: Database snapshot backup request successful.
3657+
content:
3658+
application/json:
3659+
schema:
3660+
type: object
3661+
default:
3662+
$ref: '#/components/responses/ErrorResponse'
3663+
x-code-samples:
3664+
- lang: Shell
3665+
source: >
3666+
curl -H "Authorization: Bearer $TOKEN" \
3667+
-X POST -d '{
3668+
"label": "db-snapshot",
3669+
"target": "primary"
3670+
}' \
3671+
https://api.linode.com/v4beta/databases/mysql/instances/123/backups/
3672+
- lang: CLI
3673+
source: >
3674+
linode-cli databases mysql-backup-snapshot 123 \
3675+
--label db-snapshot \
3676+
--target primary
35743677
/databases/mysql/instances/{instanceId}/backups/{backupId}:
35753678
x-linode-cli-command: databases
35763679
parameters:
@@ -3846,6 +3949,63 @@ paths:
38463949
- lang: CLI
38473950
source: >
38483951
linode-cli databases mysql-ssl-cert 123
3952+
/databases/mysql/instances/{instanceId}/patch:
3953+
x-linode-cli-command: databases
3954+
parameters:
3955+
- name: instanceId
3956+
in: path
3957+
description: The ID of the Managed MySQL Database.
3958+
required: true
3959+
schema:
3960+
type: integer
3961+
post:
3962+
tags:
3963+
- Databases
3964+
summary: Managed MySQL Database Patch
3965+
operationId: postDatabasesMySQLInstancePatch
3966+
servers:
3967+
- url: https://api.linode.com/v4beta
3968+
x-linode-cli-action: mysql-patch
3969+
x-linode-grant: unrestricted only
3970+
description: |
3971+
Update the minor patch version of the Managed MySQL Database.
3972+
3973+
The Database must have an `active` status to perform this command.
3974+
3975+
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3976+
3977+
**Note**
3978+
3979+
* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3980+
3981+
* Currently, patching does not include major releases for the database engine software (DBMS). To patch to a new major version (such as upgrading MySQL 8.0.26 to 9.0.0), consider deploying a new Managed Database with your preferred version. Then, once it's deployed, you can [migrate your database](/docs/products/databases/managed-databases/guides/migrate-mysql/).
3982+
3983+
**Beta**: This endpoint is in **open** beta. During the beta period, Managed Databases will not incur any charges.
3984+
If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the
3985+
GA (general availability) release.
3986+
When accessing this endpoint, please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be
3987+
aware that this endpoint may receive breaking updates in the future. This notice will be removed when this
3988+
endpoint is out of beta.
3989+
security:
3990+
- personalAccessToken: []
3991+
- oauth: []
3992+
responses:
3993+
'200':
3994+
description: Managed Database instance patch request successful.
3995+
content:
3996+
application/json:
3997+
schema:
3998+
type: object
3999+
default:
4000+
$ref: '#/components/responses/ErrorResponse'
4001+
x-code-samples:
4002+
- lang: Shell
4003+
source: >
4004+
curl -H "Authorization: Bearer $TOKEN" \
4005+
-X POST https://api.linode.com/v4beta/databases/mysql/instances/123/patch
4006+
- lang: CLI
4007+
source: >
4008+
linode-cli databases mysql-patch 123
38494009
/databases/types:
38504010
x-linode-cli-command: databases
38514011
get:
@@ -11296,8 +11456,6 @@ paths:
1129611456
- Networking
1129711457
summary: IP Addresses Share
1129811458
description: |
11299-
**This command is currently disabled. Please use IPv4 Sharing Configure ([POST /networking/ipv4/share](/docs/api/networking/#ipv4-sharing-configure))**
11300-
1130111459
Configure shared IPs.
1130211460

1130311461
IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if
@@ -17690,6 +17848,7 @@ components:
1769017848
- restoring
1769117849
- failed
1769217850
- degraded
17851+
- updating
1769317852
description: The operating status of the Managed Database.
1769417853
example: active
1769517854
x-linode-filterable: true
@@ -17701,6 +17860,8 @@ components:
1770117860
restoring: yellow
1770217861
failed: red
1770317862
degraded: red
17863+
updating: yellow
17864+
default_: white
1770417865
readOnly: true
1770517866
encrypted:
1770617867
type: boolean
@@ -17909,10 +18070,55 @@ components:
1790918070

1791018071
Must be `asynch` or `semi_synch` for a high availability cluster.
1791118072
x-linode-cli-display: 99
18073+
port:
18074+
type: integer
18075+
description: The access port for this Managed Database.
18076+
example: 3306
18077+
x-linode-cli-display: 98
1791218078
created:
1791318079
$ref: '#/components/schemas/Database/properties/created'
1791418080
updated:
1791518081
$ref: '#/components/schemas/Database/properties/updated'
18082+
updates:
18083+
type: object
18084+
description: Configuration settings for automated patch update maintenance for the Managed Database.
18085+
properties:
18086+
frequency:
18087+
type: string
18088+
enum:
18089+
- weekly
18090+
- monthly
18091+
description: Whether maintenance occurs on a weekly or monthly basis.
18092+
example:
18093+
duration:
18094+
type: integer
18095+
minimum: 1
18096+
maximum: 3
18097+
description: The maximum maintenance window time in hours.
18098+
example: 3
18099+
hour_of_day:
18100+
type: integer
18101+
minimum: 0
18102+
maximum: 23
18103+
description: The hour to begin maintenance based in UTC time.
18104+
example: 0
18105+
day_of_week:
18106+
type: integer
18107+
minimum: 1
18108+
maximum: 7
18109+
description: The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
18110+
example: 1
18111+
week_of_month:
18112+
type: integer
18113+
minimum: 1
18114+
maximum: 4
18115+
description: |
18116+
The week of the month to perform `monthly` frequency updates.
18117+
18118+
* Required for `monthly` frequency updates.
18119+
18120+
* Must be `null` for `weekly` frequency updates.
18121+
example: 1
1791618122
DatabaseMySQLRequest:
1791718123
type: object
1791818124
description: Managed MySQL Database request object.
@@ -17942,6 +18148,8 @@ components:
1794218148
$ref: '#/components/schemas/DatabaseMySQL/properties/ssl_connection'
1794318149
replication_type:
1794418150
$ref: '#/components/schemas/DatabaseMySQL/properties/replication_type'
18151+
updates:
18152+
$ref: '#/components/schemas/DatabaseMySQL/properties/updates'
1794518153
DatabaseSSL:
1794618154
type: object
1794718155
description: Managed Database SSL object.

0 commit comments

Comments
 (0)