From b2ae39719b41217a81869b3897d8ea3784eadd96 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Fri, 25 Oct 2024 14:22:14 +0000 Subject: [PATCH] feat: update generated APIs --- .../test-all-usage-fip-ip-attach-usage.golden | 2 +- .../test-all-usage-fip-ip-create-usage.golden | 2 +- .../test-all-usage-fip-ip-delete-usage.golden | 2 +- .../test-all-usage-fip-ip-detach-usage.golden | 2 +- .../test-all-usage-fip-ip-get-usage.golden | 2 +- .../test-all-usage-fip-ip-list-usage.golden | 2 +- .../test-all-usage-fip-ip-update-usage.golden | 2 +- ...test-all-usage-fip-mac-create-usage.golden | 2 +- ...test-all-usage-fip-mac-delete-usage.golden | 2 +- ...t-all-usage-fip-mac-duplicate-usage.golden | 2 +- .../test-all-usage-fip-mac-move-usage.golden | 2 +- ...usage-mongodb-instance-create-usage.golden | 6 +- ...usage-mongodb-instance-delete-usage.golden | 2 +- ...ll-usage-mongodb-instance-get-usage.golden | 2 +- ...l-usage-mongodb-instance-list-usage.golden | 6 +- ...usage-mongodb-instance-update-usage.golden | 2 +- ...sage-mongodb-instance-upgrade-usage.golden | 2 +- ...st-all-usage-mongodb-instance-usage.golden | 12 ++-- ...t-all-usage-mongodb-node-type-usage.golden | 5 +- ...usage-mongodb-snapshot-delete-usage.golden | 2 +- ...l-usage-mongodb-snapshot-list-usage.golden | 2 +- ...st-all-usage-mongodb-snapshot-usage.golden | 2 +- .../test-all-usage-mongodb-usage.golden | 4 +- ...ll-usage-mongodb-version-list-usage.golden | 2 +- ...est-all-usage-mongodb-version-usage.golden | 4 +- cmd/scw/testdata/test-main-usage-usage.golden | 2 +- docs/commands/fip.md | 22 +++--- docs/commands/mongodb.md | 67 ++++++++++--------- go.mod | 2 +- go.sum | 4 +- .../mongodb/v1alpha1/mongodb_cli.go | 57 ++++++++-------- 31 files changed, 119 insertions(+), 110 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-attach-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-attach-usage.golden index aa525b18c4..4b27dcbad5 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-attach-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-attach-usage.golden @@ -8,7 +8,7 @@ USAGE: ARGS: fips-ids.{index} List of flexible IP IDs to attach to a server server-id ID of the server on which to attach the flexible IPs - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for attach diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-create-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-create-usage.golden index bef0abb4ef..b7370ad54d 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-create-usage.golden @@ -12,7 +12,7 @@ ARGS: [server-id] ID of the server to which the newly created flexible IP will be attached. [reverse] Value of the reverse DNS [is-ipv6] Defines whether the flexible IP has an IPv6 address. - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for create diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-delete-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-delete-usage.golden index b25043195f..f9e6e33f90 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-delete-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: fip-id ID of the flexible IP to delete - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for delete diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-detach-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-detach-usage.golden index 5d335fbf3e..0f51399011 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-detach-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-detach-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: fips-ids.{index} List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group. - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for detach diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-get-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-get-usage.golden index 76f147aab4..b22056d274 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-get-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: fip-id ID of the flexible IP - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for get diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-list-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-list-usage.golden index 27b9f8dce5..20bc5a9185 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-list-usage.golden @@ -12,7 +12,7 @@ ARGS: [server-ids.{index}] Filter by server IDs, only flexible IPs with these server IDs will be returned [project-id] Filter by Project ID, only flexible IPs from this Project will be returned [organization-id] Filter by Organization ID, only flexible IPs from this Organization will be returned - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3 | all) FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-fip-ip-update-usage.golden b/cmd/scw/testdata/test-all-usage-fip-ip-update-usage.golden index 8363e157fe..ee4edeb95b 100644 --- a/cmd/scw/testdata/test-all-usage-fip-ip-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-ip-update-usage.golden @@ -10,7 +10,7 @@ ARGS: [description] Flexible IP description (max. 255 characters) [tags.{index}] Tags associated with the flexible IP [reverse] Value of the reverse DNS - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-fip-mac-create-usage.golden b/cmd/scw/testdata/test-all-usage-fip-mac-create-usage.golden index a832dfcaaa..0674354b4e 100644 --- a/cmd/scw/testdata/test-all-usage-fip-mac-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-mac-create-usage.golden @@ -8,7 +8,7 @@ USAGE: ARGS: fip-id ID of the flexible IP for which to generate a virtual MAC mac-type TODO (unknown_type | vmware | xen | kvm) - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for create diff --git a/cmd/scw/testdata/test-all-usage-fip-mac-delete-usage.golden b/cmd/scw/testdata/test-all-usage-fip-mac-delete-usage.golden index 15c9f78e5c..f4e83e13da 100644 --- a/cmd/scw/testdata/test-all-usage-fip-mac-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-mac-delete-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: fip-id ID of the flexible IP from which to delete the virtual MAC - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for delete diff --git a/cmd/scw/testdata/test-all-usage-fip-mac-duplicate-usage.golden b/cmd/scw/testdata/test-all-usage-fip-mac-duplicate-usage.golden index cb4bed34f5..4d1eb3b3ce 100644 --- a/cmd/scw/testdata/test-all-usage-fip-mac-duplicate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-mac-duplicate-usage.golden @@ -8,7 +8,7 @@ USAGE: ARGS: fip-id ID of the flexible IP on which to duplicate the virtual MAC duplicate-from-fip-id ID of the flexible IP to duplicate the Virtual MAC from - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for duplicate diff --git a/cmd/scw/testdata/test-all-usage-fip-mac-move-usage.golden b/cmd/scw/testdata/test-all-usage-fip-mac-move-usage.golden index d8b56af958..5658a135f2 100644 --- a/cmd/scw/testdata/test-all-usage-fip-mac-move-usage.golden +++ b/cmd/scw/testdata/test-all-usage-fip-mac-move-usage.golden @@ -8,7 +8,7 @@ USAGE: ARGS: fip-id [dst-fip-id] - [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) + [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-2 | pl-waw-3) FLAGS: -h, --help help for move diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden index b6385c081b..ebec501e3f 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Create a new MongoDB™ Database Instance. +Create a new MongoDB® Database Instance. USAGE: scw mongodb instance create [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used [name=] Name of the Database Instance - version Version of the MongoDB™ engine + version Version of the MongoDB® engine [tags.{index}] Tags to apply to the Database Instance node-number Number of node to use for the Database Instance node-type Type of node to use for the Database Instance @@ -16,7 +16,7 @@ ARGS: password Password of the initial user [volume.volume-size] Volume size [volume.volume-type] Type of volume where data is stored (unknown_type | sbs_5k | sbs_15k) - [endpoints.{index}.private-network.private-network-id] UUID of the private network + [endpoints.{index}.private-network.private-network-id] UUID of the Private Network [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden index 2b84f8f8e7..d3f7466144 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB™ Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. +Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. USAGE: scw mongodb instance delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden index 15dbd0b416..41f6ac3379 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Retrieve information about a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. +Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. USAGE: scw mongodb instance get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden index 4867dc6cf5..b9e690cacc 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List all MongoDB™ Database Instances in the specified region, for a given Scaleway Project. By default, the MongoDB™ Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. +List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. USAGE: scw mongodb instance list [arg=value ...] @@ -9,8 +9,8 @@ ARGS: [tags.{index}] List Database Instances that have a given tag [name] Lists Database Instances that match a name pattern [order-by] Criteria to use when ordering Database Instance listings (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc) - [project-id] Project ID to list the Database Instance of - [organization-id] Organization ID the Database Instance belongs to + [project-id] Project ID + [organization-id] Organization ID of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden index a84c8d7c8f..75083ca9d0 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Update the parameters of a MongoDB™ Database Instance. +Update the parameters of a MongoDB® Database Instance. USAGE: scw mongodb instance update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden index de07e717f9..1cc38c9923 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: instance-id UUID of the Database Instance you want to upgrade - [volume-size] Increase your block storage volume size + [volume-size] Increase your Block Storage volume size [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden index f0d58e335b..1ec546e4d3 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine. +A Managed Database for MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine. USAGE: scw mongodb instance AVAILABLE COMMANDS: - create Create a MongoDB™ Database Instance - delete Delete a MongoDB™ Database Instance - get Get a MongoDB™ Database Instance + create Create a MongoDB® Database Instance + delete Delete a MongoDB® Database Instance + get Get a MongoDB® Database Instance get-certificate Get the certificate of a Database Instance - list List MongoDB™ Database Instances - update Update a MongoDB™ Database Instance + list List MongoDB® Database Instances + update Update a MongoDB® Database Instance upgrade Upgrade a Database Instance FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden index d6b74c5200..48f83d04bf 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden @@ -1,6 +1,9 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Node types powering your instance. +Two node type ranges are available: + +* **Cost-Optimized:** a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices. +* **Production-Optimized:** database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications. USAGE: scw mongodb node-type diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden index fecc6a4a45..305a2f21cb 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete. +Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete. USAGE: scw mongodb snapshot delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden index a609b24614..24c593dfb7 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: [instance-id] Instance ID the snapshots belongs to - [name] Lists Database snapshots that match a name pattern + [name] Lists database snapshots that match a name pattern [order-by] Criteria to use when ordering snapshot listings (created_at_asc | created_at_desc | name_asc | name_desc | expires_at_asc | expires_at_desc) [project-id] Project ID to list the snapshots of [organization-id] Organization ID the snapshots belongs to diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden index 3058ce3f37..9882792c72 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Snapshots of your instance. +A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. USAGE: scw mongodb snapshot diff --git a/cmd/scw/testdata/test-all-usage-mongodb-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-usage.golden index 48507e002d..a612c08d57 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -This API allows you to manage your Managed Databases for MongoDB. +This API allows you to manage your Managed Databases for MongoDB®. USAGE: scw mongodb @@ -10,7 +10,7 @@ AVAILABLE COMMANDS: node-type Node types management commands snapshot Snapshot management commands user User management commands - version MongoDB™ version management commands + version MongoDB® version management commands FLAGS: -h, --help help for mongodb diff --git a/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden index ee3c415d73..6c368ef78f 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List available MongoDB™ versions. +List available MongoDB® versions. USAGE: scw mongodb version list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden index 4b4242b421..243d83fd1b 100644 --- a/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden +++ b/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -MongoDB™ versions powering your instance. +A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance. USAGE: scw mongodb version AVAILABLE COMMANDS: - list List available MongoDB™ versions + list List available MongoDB® versions FLAGS: -h, --help help for version diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden index 4b65437cb6..306427d95b 100644 --- a/cmd/scw/testdata/test-main-usage-usage.golden +++ b/cmd/scw/testdata/test-main-usage-usage.golden @@ -29,7 +29,7 @@ AVAILABLE COMMANDS: lb This API allows you to manage your Scaleway Load Balancer services marketplace This API allows you to find available images for use when launching a Scaleway Instance mnq These APIs allow you to manage your Messaging and Queuing NATS, SQS and SNS services - mongodb This API allows you to manage your Managed Databases for MongoDB + mongodb This API allows you to manage your Managed Databases for MongoDB® object Object-storage utils rdb This API allows you to manage your Managed Databases for PostgreSQL and MySQL redis This API allows you to manage your Managed Databases for Redis™ diff --git a/docs/commands/fip.md b/docs/commands/fip.md index 49bb6baffa..d8f08db3be 100644 --- a/docs/commands/fip.md +++ b/docs/commands/fip.md @@ -40,7 +40,7 @@ scw fip ip attach [arg=value ...] |------|---|-------------| | fips-ids.{index} | Required | List of flexible IP IDs to attach to a server | | server-id | Required | ID of the server on which to attach the flexible IPs | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -65,7 +65,7 @@ scw fip ip create [arg=value ...] | server-id | | ID of the server to which the newly created flexible IP will be attached. | | reverse | | Value of the reverse DNS | | is-ipv6 | | Defines whether the flexible IP has an IPv6 address. | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -85,7 +85,7 @@ scw fip ip delete [arg=value ...] | Name | | Description | |------|---|-------------| | fip-id | Required | ID of the flexible IP to delete | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -105,7 +105,7 @@ scw fip ip detach [arg=value ...] | Name | | Description | |------|---|-------------| | fips-ids.{index} | Required | List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group. | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -125,7 +125,7 @@ scw fip ip get [arg=value ...] | Name | | Description | |------|---|-------------| | fip-id | Required | ID of the flexible IP | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -150,7 +150,7 @@ scw fip ip list [arg=value ...] | server-ids.{index} | | Filter by server IDs, only flexible IPs with these server IDs will be returned | | project-id | | Filter by Project ID, only flexible IPs from this Project will be returned | | organization-id | | Filter by Organization ID, only flexible IPs from this Organization will be returned | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -173,7 +173,7 @@ scw fip ip update [arg=value ...] | description | | Flexible IP description (max. 255 characters) | | tags.{index} | | Tags associated with the flexible IP | | reverse | | Value of the reverse DNS | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -199,7 +199,7 @@ scw fip mac create [arg=value ...] |------|---|-------------| | fip-id | Required | ID of the flexible IP for which to generate a virtual MAC | | mac-type | Required
One of: `unknown_type`, `vmware`, `xen`, `kvm` | TODO | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -219,7 +219,7 @@ scw fip mac delete [arg=value ...] | Name | | Description | |------|---|-------------| | fip-id | Required | ID of the flexible IP from which to delete the virtual MAC | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -240,7 +240,7 @@ scw fip mac duplicate [arg=value ...] |------|---|-------------| | fip-id | Required | ID of the flexible IP on which to duplicate the virtual MAC | | duplicate-from-fip-id | Required | ID of the flexible IP to duplicate the Virtual MAC from | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | @@ -261,7 +261,7 @@ scw fip mac move [arg=value ...] |------|---|-------------| | fip-id | Required | | | dst-fip-id | | | -| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config | diff --git a/docs/commands/mongodb.md b/docs/commands/mongodb.md index f67923b3e5..9b18e89cd7 100644 --- a/docs/commands/mongodb.md +++ b/docs/commands/mongodb.md @@ -1,14 +1,14 @@ # Documentation for `scw mongodb` -This API allows you to manage your Managed Databases for MongoDB. +This API allows you to manage your Managed Databases for MongoDB®. - [Instance management commands](#instance-management-commands) - - [Create a MongoDB™ Database Instance](#create-a-mongodb™-database-instance) - - [Delete a MongoDB™ Database Instance](#delete-a-mongodb™-database-instance) - - [Get a MongoDB™ Database Instance](#get-a-mongodb™-database-instance) + - [Create a MongoDB® Database Instance](#create-a-mongodb®-database-instance) + - [Delete a MongoDB® Database Instance](#delete-a-mongodb®-database-instance) + - [Get a MongoDB® Database Instance](#get-a-mongodb®-database-instance) - [Get the certificate of a Database Instance](#get-the-certificate-of-a-database-instance) - - [List MongoDB™ Database Instances](#list-mongodb™-database-instances) - - [Update a MongoDB™ Database Instance](#update-a-mongodb™-database-instance) + - [List MongoDB® Database Instances](#list-mongodb®-database-instances) + - [Update a MongoDB® Database Instance](#update-a-mongodb®-database-instance) - [Upgrade a Database Instance](#upgrade-a-database-instance) - [Node types management commands](#node-types-management-commands) - [List available node types](#list-available-node-types) @@ -22,18 +22,18 @@ This API allows you to manage your Managed Databases for MongoDB. - [User management commands](#user-management-commands) - [List users of a Database Instance](#list-users-of-a-database-instance) - [Update a user on a Database Instance](#update-a-user-on-a-database-instance) -- [MongoDB™ version management commands](#mongodb™-version-management-commands) - - [List available MongoDB™ versions](#list-available-mongodb™-versions) +- [MongoDB® version management commands](#mongodb®-version-management-commands) + - [List available MongoDB® versions](#list-available-mongodb®-versions) ## Instance management commands -A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine. +A Managed Database for MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine. -### Create a MongoDB™ Database Instance +### Create a MongoDB® Database Instance -Create a new MongoDB™ Database Instance. +Create a new MongoDB® Database Instance. **Usage:** @@ -48,7 +48,7 @@ scw mongodb instance create [arg=value ...] |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | | name | Default: `` | Name of the Database Instance | -| version | Required | Version of the MongoDB™ engine | +| version | Required | Version of the MongoDB® engine | | tags.{index} | | Tags to apply to the Database Instance | | node-number | Required | Number of node to use for the Database Instance | | node-type | Required | Type of node to use for the Database Instance | @@ -56,14 +56,14 @@ scw mongodb instance create [arg=value ...] | password | Required | Password of the initial user | | volume.volume-size | | Volume size | | volume.volume-type | One of: `unknown_type`, `sbs_5k`, `sbs_15k` | Type of volume where data is stored | -| endpoints.{index}.private-network.private-network-id | | UUID of the private network | +| endpoints.{index}.private-network.private-network-id | | UUID of the Private Network | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete a MongoDB™ Database Instance +### Delete a MongoDB® Database Instance -Delete a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB™ Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. +Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. **Usage:** @@ -81,9 +81,9 @@ scw mongodb instance delete [arg=value ...] -### Get a MongoDB™ Database Instance +### Get a MongoDB® Database Instance -Retrieve information about a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. +Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. **Usage:** @@ -121,9 +121,9 @@ scw mongodb instance get-certificate [arg=value ...] -### List MongoDB™ Database Instances +### List MongoDB® Database Instances -List all MongoDB™ Database Instances in the specified region, for a given Scaleway Project. By default, the MongoDB™ Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. +List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. **Usage:** @@ -139,15 +139,15 @@ scw mongodb instance list [arg=value ...] | tags.{index} | | List Database Instances that have a given tag | | name | | Lists Database Instances that match a name pattern | | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `status_asc`, `status_desc` | Criteria to use when ordering Database Instance listings | -| project-id | | Project ID to list the Database Instance of | -| organization-id | | Organization ID the Database Instance belongs to | +| project-id | | Project ID | +| organization-id | | Organization ID of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | -### Update a MongoDB™ Database Instance +### Update a MongoDB® Database Instance -Update the parameters of a MongoDB™ Database Instance. +Update the parameters of a MongoDB® Database Instance. **Usage:** @@ -183,14 +183,17 @@ scw mongodb instance upgrade [arg=value ...] | Name | | Description | |------|---|-------------| | instance-id | Required | UUID of the Database Instance you want to upgrade | -| volume-size | | Increase your block storage volume size | +| volume-size | | Increase your Block Storage volume size | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ## Node types management commands -Node types powering your instance. +Two node type ranges are available: + +* **Cost-Optimized:** a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices. +* **Production-Optimized:** database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications. ### List available node types @@ -215,7 +218,7 @@ scw mongodb node-type list [arg=value ...] ## Snapshot management commands -Snapshots of your instance. +A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. ### Create a Database Instance snapshot @@ -242,7 +245,7 @@ scw mongodb snapshot create [arg=value ...] ### Delete a Database Instance snapshot -Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete. +Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete. **Usage:** @@ -296,7 +299,7 @@ scw mongodb snapshot list [arg=value ...] | Name | | Description | |------|---|-------------| | instance-id | | Instance ID the snapshots belongs to | -| name | | Lists Database snapshots that match a name pattern | +| name | | Lists database snapshots that match a name pattern | | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `expires_at_asc`, `expires_at_desc` | Criteria to use when ordering snapshot listings | | project-id | | Project ID to list the snapshots of | | organization-id | | Organization ID the snapshots belongs to | @@ -399,14 +402,14 @@ scw mongodb user update [arg=value ...] -## MongoDB™ version management commands +## MongoDB® version management commands -MongoDB™ versions powering your instance. +A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance. -### List available MongoDB™ versions +### List available MongoDB® versions -List available MongoDB™ versions. +List available MongoDB® versions. **Usage:** diff --git a/go.mod b/go.mod index 0091fcb1a8..50c59ddc47 100644 --- a/go.mod +++ b/go.mod @@ -26,7 +26,7 @@ require ( github.com/mattn/go-isatty v0.0.20 github.com/moby/buildkit v0.13.2 github.com/opencontainers/go-digest v1.0.0 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241023141424-2a6e7206bfc4 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025112925-105ce0f288e4 github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 github.com/spf13/cobra v1.8.1 github.com/spf13/pflag v1.0.5 diff --git a/go.sum b/go.sum index 5a9f29ea1c..5a3c7c73f8 100644 --- a/go.sum +++ b/go.sum @@ -465,8 +465,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241023141424-2a6e7206bfc4 h1:okyDIIJ9HiRGLNhONgQqWIdT/Aw5VyedIJWqjj+OR0Y= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241023141424-2a6e7206bfc4/go.mod h1:3jrRJM7638J+P33hKy9MBvfOBxNo8pEGNQQoIv65Ihg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025112925-105ce0f288e4 h1:2pEfSGb8zVgPgS1sQHMeJX+TaMMMkeldFjqR/J7ZZyI= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025112925-105ce0f288e4/go.mod h1:3jrRJM7638J+P33hKy9MBvfOBxNo8pEGNQQoIv65Ihg= github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8= github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM= github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA= diff --git a/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go b/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go index b7676a07e1..6c1306698a 100644 --- a/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go +++ b/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go @@ -46,16 +46,19 @@ func GetGeneratedCommands() *core.Commands { } func mongodbRoot() *core.Command { return &core.Command{ - Short: `This API allows you to manage your Managed Databases for MongoDB`, - Long: `This API allows you to manage your Managed Databases for MongoDB.`, + Short: `This API allows you to manage your Managed Databases for MongoDB®`, + Long: `This API allows you to manage your Managed Databases for MongoDB®.`, Namespace: "mongodb", } } func mongodbNodeType() *core.Command { return &core.Command{ - Short: `Node types management commands`, - Long: `Node types powering your instance.`, + Short: `Node types management commands`, + Long: `Two node type ranges are available: + +* **Cost-Optimized:** a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices. +* **Production-Optimized:** database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications.`, Namespace: "mongodb", Resource: "node-type", } @@ -63,8 +66,8 @@ func mongodbNodeType() *core.Command { func mongodbVersion() *core.Command { return &core.Command{ - Short: `MongoDB™ version management commands`, - Long: `MongoDB™ versions powering your instance.`, + Short: `MongoDB® version management commands`, + Long: `A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance.`, Namespace: "mongodb", Resource: "version", } @@ -73,7 +76,7 @@ func mongodbVersion() *core.Command { func mongodbInstance() *core.Command { return &core.Command{ Short: `Instance management commands`, - Long: `A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine.`, + Long: `A Managed Database for MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine.`, Namespace: "mongodb", Resource: "instance", } @@ -82,7 +85,7 @@ func mongodbInstance() *core.Command { func mongodbSnapshot() *core.Command { return &core.Command{ Short: `Snapshot management commands`, - Long: `Snapshots of your instance.`, + Long: `A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time.`, Namespace: "mongodb", Resource: "snapshot", } @@ -138,8 +141,8 @@ func mongodbNodeTypeList() *core.Command { func mongodbVersionList() *core.Command { return &core.Command{ - Short: `List available MongoDB™ versions`, - Long: `List available MongoDB™ versions.`, + Short: `List available MongoDB® versions`, + Long: `List available MongoDB® versions.`, Namespace: "mongodb", Resource: "version", Verb: "list", @@ -176,8 +179,8 @@ func mongodbVersionList() *core.Command { func mongodbInstanceList() *core.Command { return &core.Command{ - Short: `List MongoDB™ Database Instances`, - Long: `List all MongoDB™ Database Instances in the specified region, for a given Scaleway Project. By default, the MongoDB™ Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as ` + "`" + `tags` + "`" + ` and ` + "`" + `name` + "`" + `. For the ` + "`" + `name` + "`" + ` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.`, + Short: `List MongoDB® Database Instances`, + Long: `List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as ` + "`" + `tags` + "`" + ` and ` + "`" + `name` + "`" + `. For the ` + "`" + `name` + "`" + ` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.`, Namespace: "mongodb", Resource: "instance", Verb: "list", @@ -208,14 +211,14 @@ func mongodbInstanceList() *core.Command { }, { Name: "project-id", - Short: `Project ID to list the Database Instance of`, + Short: `Project ID`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Organization ID the Database Instance belongs to`, + Short: `Organization ID of the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -244,8 +247,8 @@ func mongodbInstanceList() *core.Command { func mongodbInstanceGet() *core.Command { return &core.Command{ - Short: `Get a MongoDB™ Database Instance`, - Long: `Retrieve information about a given MongoDB™ Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Its full details, including name, status, IP address and port, are returned in the response object.`, + Short: `Get a MongoDB® Database Instance`, + Long: `Retrieve information about a given MongoDB® Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Its full details, including name, status, IP address and port, are returned in the response object.`, Namespace: "mongodb", Resource: "instance", Verb: "get", @@ -274,8 +277,8 @@ func mongodbInstanceGet() *core.Command { func mongodbInstanceCreate() *core.Command { return &core.Command{ - Short: `Create a MongoDB™ Database Instance`, - Long: `Create a new MongoDB™ Database Instance.`, + Short: `Create a MongoDB® Database Instance`, + Long: `Create a new MongoDB® Database Instance.`, Namespace: "mongodb", Resource: "instance", Verb: "create", @@ -293,7 +296,7 @@ func mongodbInstanceCreate() *core.Command { }, { Name: "version", - Short: `Version of the MongoDB™ engine`, + Short: `Version of the MongoDB® engine`, Required: true, Deprecated: false, Positional: false, @@ -350,7 +353,7 @@ func mongodbInstanceCreate() *core.Command { }, { Name: "endpoints.{index}.private-network.private-network-id", - Short: `UUID of the private network`, + Short: `UUID of the Private Network`, Required: false, Deprecated: false, Positional: false, @@ -370,8 +373,8 @@ func mongodbInstanceCreate() *core.Command { func mongodbInstanceUpdate() *core.Command { return &core.Command{ - Short: `Update a MongoDB™ Database Instance`, - Long: `Update the parameters of a MongoDB™ Database Instance.`, + Short: `Update a MongoDB® Database Instance`, + Long: `Update the parameters of a MongoDB® Database Instance.`, Namespace: "mongodb", Resource: "instance", Verb: "update", @@ -414,8 +417,8 @@ func mongodbInstanceUpdate() *core.Command { func mongodbInstanceDelete() *core.Command { return &core.Command{ - Short: `Delete a MongoDB™ Database Instance`, - Long: `Delete a given MongoDB™ Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Deleting a MongoDB™ Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.`, + Short: `Delete a MongoDB® Database Instance`, + Long: `Delete a given MongoDB® Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.`, Namespace: "mongodb", Resource: "instance", Verb: "delete", @@ -461,7 +464,7 @@ func mongodbInstanceUpgrade() *core.Command { }, { Name: "volume-size", - Short: `Increase your block storage volume size`, + Short: `Increase your Block Storage volume size`, Required: false, Deprecated: false, Positional: false, @@ -705,7 +708,7 @@ func mongodbSnapshotList() *core.Command { }, { Name: "name", - Short: `Lists Database snapshots that match a name pattern`, + Short: `Lists database snapshots that match a name pattern`, Required: false, Deprecated: false, Positional: false, @@ -757,7 +760,7 @@ func mongodbSnapshotList() *core.Command { func mongodbSnapshotDelete() *core.Command { return &core.Command{ Short: `Delete a Database Instance snapshot`, - Long: `Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the ` + "`" + `snapshot_id` + "`" + ` parameter of the snapshot you want to delete.`, + Long: `Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the ` + "`" + `snapshot_id` + "`" + ` parameter of the snapshot you want to delete.`, Namespace: "mongodb", Resource: "snapshot", Verb: "delete",