Skip to content

Commit 3208861

Browse files
committed
Fixes for Database Backup Snapshot Create
1 parent 46b7137 commit 3208861

File tree

1 file changed

+47
-85
lines changed

1 file changed

+47
-85
lines changed

openapi.yaml

Lines changed: 47 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -3611,9 +3611,11 @@ paths:
36113611

36123612
Requires `read_write` access to the Database.
36133613

3614+
Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.
3615+
36143616
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.
36153617

3616-
The Database must have an `active` status to perform this command.
3618+
The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
36173619

36183620
**Note**: New MongoDB Databases cannot currently be created.
36193621
security:
@@ -3625,30 +3627,7 @@ paths:
36253627
content:
36263628
application/json:
36273629
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-
* Must use only letters, numbers, underscores, dashes, and periods.
3639-
* Must begin and end with a letter or number.
3640-
* Must not include two dashes, underscores, or periods in a row.
3641-
example: db-snapshot
3642-
target:
3643-
type: string
3644-
enum:
3645-
- primary
3646-
- secondary
3647-
default: primary
3648-
description: |
3649-
The Database cluster target.
3650-
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
3651-
example: primary
3630+
$ref: '#/components/schemas/DatabaseBackupSnapshot'
36523631
responses:
36533632
'200':
36543633
description: Database snapshot backup request successful.
@@ -3662,15 +3641,16 @@ paths:
36623641
- lang: Shell
36633642
source: >
36643643
curl -H "Authorization: Bearer $TOKEN" \
3644+
-H "Content-Type: application/json" \
36653645
-X POST -d '{
3666-
"label": "db-snapshot",
3646+
"label": "snapshot1",
36673647
"target": "primary"
36683648
}' \
36693649
https://api.linode.com/v4/databases/mongodb/instances/123/backups/
36703650
- lang: CLI
36713651
source: >
36723652
linode-cli databases mongodb-backup-snapshot 123 \
3673-
--label db-snapshot \
3653+
--label snapshot1 \
36743654
--target primary
36753655
/databases/mongodb/instances/{instanceId}/backups/{backupId}:
36763656
x-linode-cli-command: databases
@@ -4399,9 +4379,11 @@ paths:
43994379

44004380
Requires `read_write` access to the Database.
44014381

4382+
Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.
4383+
44024384
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.
44034385

4404-
The Database must have an `active` status to perform this command.
4386+
The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
44054387
security:
44064388
- personalAccessToken: []
44074389
- oauth:
@@ -4411,32 +4393,7 @@ paths:
44114393
content:
44124394
application/json:
44134395
schema:
4414-
required:
4415-
- label
4416-
type: object
4417-
properties:
4418-
label:
4419-
type: string
4420-
minLength: 3
4421-
maxLength: 64
4422-
description: |
4423-
The label for the Database snapshot backup.
4424-
4425-
* Must use only letters, numbers, underscores, dashes, and periods.
4426-
* Must begin and end with a letter or number.
4427-
* Must not include two dashes, underscores, or periods in a row.
4428-
example: db-snapshot
4429-
target:
4430-
type: string
4431-
enum:
4432-
- primary
4433-
- secondary
4434-
default: primary
4435-
description: |
4436-
The Database cluster target.
4437-
4438-
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
4439-
example: primary
4396+
$ref: '#/components/schemas/DatabaseBackupSnapshot'
44404397
responses:
44414398
'200':
44424399
description: Database snapshot backup request successful.
@@ -4450,15 +4407,16 @@ paths:
44504407
- lang: Shell
44514408
source: >
44524409
curl -H "Authorization: Bearer $TOKEN" \
4410+
-H "Content-Type: application/json" \
44534411
-X POST -d '{
4454-
"label": "db-snapshot",
4412+
"label": "snapshot1",
44554413
"target": "primary"
44564414
}' \
44574415
https://api.linode.com/v4/databases/mysql/instances/123/backups/
44584416
- lang: CLI
44594417
source: >
44604418
linode-cli databases mysql-backup-snapshot 123 \
4461-
--label db-snapshot \
4419+
--label snapshot1 \
44624420
--target primary
44634421
/databases/mysql/instances/{instanceId}/backups/{backupId}:
44644422
x-linode-cli-command: databases
@@ -5176,9 +5134,11 @@ paths:
51765134

51775135
Requires `read_write` access to the Database.
51785136

5137+
Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.
5138+
51795139
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.
51805140

5181-
The Database must have an `active` status to perform this command.
5141+
The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
51825142
security:
51835143
- personalAccessToken: []
51845144
- oauth:
@@ -5188,32 +5148,7 @@ paths:
51885148
content:
51895149
application/json:
51905150
schema:
5191-
required:
5192-
- label
5193-
type: object
5194-
properties:
5195-
label:
5196-
type: string
5197-
minLength: 3
5198-
maxLength: 64
5199-
description: |
5200-
The label for the Database snapshot backup.
5201-
5202-
* Must use only letters, numbers, underscores, dashes, and periods.
5203-
* Must begin and end with a letter or number.
5204-
* Must not include two dashes, underscores, or periods in a row.
5205-
example: db-snapshot
5206-
target:
5207-
type: string
5208-
enum:
5209-
- primary
5210-
- secondary
5211-
default: primary
5212-
description: |
5213-
The Database cluster target.
5214-
5215-
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
5216-
example: primary
5151+
$ref: '#/components/schemas/DatabaseBackupSnapshot'
52175152
responses:
52185153
'200':
52195154
description: Database snapshot backup request successful.
@@ -5227,15 +5162,16 @@ paths:
52275162
- lang: Shell
52285163
source: >
52295164
curl -H "Authorization: Bearer $TOKEN" \
5165+
-H "Content-Type: application/json" \
52305166
-X POST -d '{
5231-
"label": "db-snapshot",
5167+
"label": "snapshot1",
52325168
"target": "primary"
52335169
}' \
52345170
https://api.linode.com/v4/databases/postgresql/instances/123/backups/
52355171
- lang: CLI
52365172
source: >
52375173
linode-cli databases postgresql-backup-snapshot 123 \
5238-
--label db-snapshot \
5174+
--label snapshot1 \
52395175
--target primary
52405176
/databases/postgresql/instances/{instanceId}/backups/{backupId}:
52415177
x-linode-cli-command: databases
@@ -20059,6 +19995,32 @@ components:
2005919995
description: A time value given in a combined date and time format that represents when the database backup was created.
2006019996
x-linode-filterable: true
2006119997
x-linode-cli-display: 4
19998+
DatabaseBackupSnapshot:
19999+
type: object
20000+
description: Managed Database request object for snapshot backup.
20001+
required:
20002+
- label
20003+
properties:
20004+
label:
20005+
type: string
20006+
minLength: 1
20007+
maxLength: 30
20008+
description: |
20009+
The label for the Database snapshot backup.
20010+
20011+
* Must include only ASCII letters or numbers.
20012+
* Must be unique among other backup labels for this Database.
20013+
example: db-snapshot
20014+
target:
20015+
type: string
20016+
enum:
20017+
- primary
20018+
- secondary
20019+
default: primary
20020+
description: |
20021+
The Database cluster target.
20022+
If the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.
20023+
example: primary
2006220024
DatabaseCredentials:
2006320025
type: object
2006420026
description: Managed Database object for database credentials.

0 commit comments

Comments
 (0)