Skip to content

[Fix] Managed MongoDB Databases - reinsert line breaks #682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3218,6 +3218,7 @@ paths:
- $ref: '#/components/parameters/pageSize'
description: |
Display all accessible Managed MongoDB Databases.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3361,6 +3362,7 @@ paths:
x-linode-grant: read_only
description: |
Display information for a single, accessible Managed MongoDB Database.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3395,9 +3397,13 @@ paths:
x-linode-grant: read_write
description: |
Remove a Managed MongoDB Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

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

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3433,15 +3439,24 @@ paths:
x-linode-grant: read_write
description: |
Update a Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses on this list can access the Managed Database. All other sources are blocked.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **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.
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.

* 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.

* **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.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3526,9 +3541,13 @@ paths:
- $ref: '#/components/parameters/pageSize'
description: |
Display all backups for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

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.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3570,9 +3589,13 @@ paths:
x-linode-grant: read_write
description: |
Creates a snapshot backup of a Managed MongoDB Database.

Requires `read_write` access to the Database.

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.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3657,7 +3680,9 @@ paths:
x-linode-grant: read_only
description: |
Display information for a single backup for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3692,8 +3717,11 @@ paths:
x-linode-grant: unrestricted only
description: |
Delete a single backup for an accessible Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3744,10 +3772,15 @@ paths:
x-linode-grant: read_write
description: |
Restore a backup to a Managed MongoDB Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3791,7 +3824,9 @@ paths:
x-linode-grant: read_only
description: |
Display the root username and password for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3835,10 +3870,15 @@ paths:
x-linode-grant: read_write
description: |
Reset the root password for a Managed MongoDB Database.

Requires `read_write` access to the Database.

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.

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

**Note**: Note that it may take several seconds for credentials to reset.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3882,7 +3922,9 @@ paths:
x-linode-grant: read_only
description: |
Display the SSL CA certificate for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down Expand Up @@ -3927,10 +3969,15 @@ paths:
description: |
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.
Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.
**Note**

**Note**:

* 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.

* **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.

**Note**: New MongoDB Databases cannot currently be created.
security:
- personalAccessToken: []
Expand Down