Skip to content

Commit 4968f98

Browse files
authored
Merge pull request #682 from bbiggerr/databases-fix-spacing
[Fix] Managed MongoDB Databases - reinsert line breaks
2 parents 99b04b8 + 105f941 commit 4968f98

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

openapi.yaml

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3218,6 +3218,7 @@ paths:
32183218
- $ref: '#/components/parameters/pageSize'
32193219
description: |
32203220
Display all accessible Managed MongoDB Databases.
3221+
32213222
**Note**: New MongoDB Databases cannot currently be created.
32223223
security:
32233224
- personalAccessToken: []
@@ -3361,6 +3362,7 @@ paths:
33613362
x-linode-grant: read_only
33623363
description: |
33633364
Display information for a single, accessible Managed MongoDB Database.
3365+
33643366
**Note**: New MongoDB Databases cannot currently be created.
33653367
security:
33663368
- personalAccessToken: []
@@ -3395,9 +3397,13 @@ paths:
33953397
x-linode-grant: read_write
33963398
description: |
33973399
Remove a Managed MongoDB Database from your Account.
3400+
33983401
Requires `read_write` access to the Database.
3402+
33993403
The Database must have an `active`, `failed`, or `degraded` status to perform this command.
3404+
34003405
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3406+
34013407
**Note**: New MongoDB Databases cannot currently be created.
34023408
security:
34033409
- personalAccessToken: []
@@ -3433,15 +3439,24 @@ paths:
34333439
x-linode-grant: read_write
34343440
description: |
34353441
Update a Managed MongoDB Database.
3442+
34363443
Requires `read_write` access to the Database.
3444+
34373445
The Database must have an `active` status to perform this command.
3446+
34383447
Updating addresses in the `allow_list` overwrites any existing addresses.
3448+
34393449
* IP addresses on this list can access the Managed Database. All other sources are blocked.
3450+
34403451
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
3452+
34413453
* **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.
34423454
All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.
3455+
34433456
* 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.
3457+
34443458
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3459+
34453460
**Note**: New MongoDB Databases cannot currently be created.
34463461
security:
34473462
- personalAccessToken: []
@@ -3526,9 +3541,13 @@ paths:
35263541
- $ref: '#/components/parameters/pageSize'
35273542
description: |
35283543
Display all backups for an accessible Managed MongoDB Database.
3544+
35293545
The Database must not be provisioning to perform this command.
3546+
35303547
Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.
3548+
35313549
Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.
3550+
35323551
**Note**: New MongoDB Databases cannot currently be created.
35333552
security:
35343553
- personalAccessToken: []
@@ -3570,9 +3589,13 @@ paths:
35703589
x-linode-grant: read_write
35713590
description: |
35723591
Creates a snapshot backup of a Managed MongoDB Database.
3592+
35733593
Requires `read_write` access to the Database.
3594+
35743595
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.
3596+
35753597
The Database must have an `active` status to perform this command.
3598+
35763599
**Note**: New MongoDB Databases cannot currently be created.
35773600
security:
35783601
- personalAccessToken: []
@@ -3657,7 +3680,9 @@ paths:
36573680
x-linode-grant: read_only
36583681
description: |
36593682
Display information for a single backup for an accessible Managed MongoDB Database.
3683+
36603684
The Database must not be provisioning to perform this command.
3685+
36613686
**Note**: New MongoDB Databases cannot currently be created.
36623687
security:
36633688
- personalAccessToken: []
@@ -3692,8 +3717,11 @@ paths:
36923717
x-linode-grant: unrestricted only
36933718
description: |
36943719
Delete a single backup for an accessible Managed MongoDB Database.
3720+
36953721
Requires `read_write` access to the Database.
3722+
36963723
The Database must not be provisioning to perform this command.
3724+
36973725
**Note**: New MongoDB Databases cannot currently be created.
36983726
security:
36993727
- personalAccessToken: []
@@ -3744,10 +3772,15 @@ paths:
37443772
x-linode-grant: read_write
37453773
description: |
37463774
Restore a backup to a Managed MongoDB Database on your Account.
3775+
37473776
Requires `read_write` access to the Database.
3777+
37483778
The Database must have an `active` status to perform this command.
3779+
37493780
**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.
3781+
37503782
**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
3783+
37513784
**Note**: New MongoDB Databases cannot currently be created.
37523785
security:
37533786
- personalAccessToken: []
@@ -3791,7 +3824,9 @@ paths:
37913824
x-linode-grant: read_only
37923825
description: |
37933826
Display the root username and password for an accessible Managed MongoDB Database.
3827+
37943828
The Database must have an `active` status to perform this command.
3829+
37953830
**Note**: New MongoDB Databases cannot currently be created.
37963831
security:
37973832
- personalAccessToken: []
@@ -3835,10 +3870,15 @@ paths:
38353870
x-linode-grant: read_write
38363871
description: |
38373872
Reset the root password for a Managed MongoDB Database.
3873+
38383874
Requires `read_write` access to the Database.
3875+
38393876
A new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.
3877+
38403878
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3879+
38413880
**Note**: Note that it may take several seconds for credentials to reset.
3881+
38423882
**Note**: New MongoDB Databases cannot currently be created.
38433883
security:
38443884
- personalAccessToken: []
@@ -3882,7 +3922,9 @@ paths:
38823922
x-linode-grant: read_only
38833923
description: |
38843924
Display the SSL CA certificate for an accessible Managed MongoDB Database.
3925+
38853926
The Database must have an `active` status to perform this command.
3927+
38863928
**Note**: New MongoDB Databases cannot currently be created.
38873929
security:
38883930
- personalAccessToken: []
@@ -3927,10 +3969,15 @@ paths:
39273969
description: |
39283970
Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
39293971
Requires `read_write` access to the Database.
3972+
39303973
The Database must have an `active` status to perform this command.
3931-
**Note**
3974+
3975+
**Note**:
3976+
39323977
* 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.
3978+
39333979
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3980+
39343981
**Note**: New MongoDB Databases cannot currently be created.
39353982
security:
39363983
- personalAccessToken: []

0 commit comments

Comments
 (0)