Skip to content
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

docs(mnq): follow the renaming of the product on the current API #4335

Merged
merged 1 commit into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Activate SNS for the specified Project ID. SNS must be activated before any usage. Activating SNS does not trigger any billing, and you can deactivate at any time.
Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.

USAGE:
scw mnq sns activate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a set of credentials for SNS, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.

USAGE:
scw mnq sns create-credentials [arg=value ...]

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[name=<generated>] Name of the credentials
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (publish to SNS topics)
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from the service (configure subscriptions)
[permissions.can-manage] Defines whether the credentials bearer can manage the associated SNS topics or subscriptions
[permissions.can-manage] Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Deactivate SNS for the specified Project ID.You must delete all topics and credentials before this call or you need to set the force_delete parameter.
Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.

USAGE:
scw mnq sns deactivate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a set of SNS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SNS.
Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.

USAGE:
scw mnq sns delete-credentials <sns-credentials-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw mnq sns get-credentials <sns-credentials-id ...> [arg=value ...]

ARGS:
sns-credentials-id ID of the SNS credentials to get
sns-credentials-id ID of the Topics and Events credentials to get
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve the SNS information of the specified Project ID. Informations include the activation status and the SNS API endpoint URL.
Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.

USAGE:
scw mnq sns get-info [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.

USAGE:
scw mnq sns list-credentials [arg=value ...]

ARGS:
[project-id] Include only SNS credentials in this Project
[project-id] Include only Topics and Events credentials in this Project
[order-by] Order in which to return results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | all)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update a set of SNS credentials. You can update the credentials' name, or their permissions.
Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.

USAGE:
scw mnq sns update-credentials <sns-credentials-id ...> [arg=value ...]

ARGS:
sns-credentials-id ID of the SNS credentials to update
sns-credentials-id ID of the Topics and Events credentials to update
[name] Name of the credentials
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (publish to SNS topics)
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from the service (configure subscriptions)
[permissions.can-manage] Defines whether the credentials bearer can manage the associated SNS topics or subscriptions
[permissions.can-manage] Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
18 changes: 9 additions & 9 deletions cmd/scw/testdata/test-all-usage-mnq-sns-usage.golden
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
MnQ SNS commands.
MnQ Topics and Events commands.

USAGE:
scw mnq sns <command>

AVAILABLE COMMANDS:
activate Activate SNS
create-credentials Create SNS credentials
deactivate Deactivate SNS
delete-credentials Delete SNS credentials
get-credentials Get SNS credentials
get-info Get SNS info
list-credentials List SNS credentials
update-credentials Update SNS credentials
activate Activate Topics and Events
create-credentials Create Topics and Events credentials
deactivate Deactivate Topics and Events
delete-credentials Delete Topics and Events credentials
get-credentials Get Topics and Events credentials
get-info Get Topics and Events info
list-credentials List Topics and Events credentials
update-credentials Update Topics and Events credentials

FLAGS:
-h, --help help for sns
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Activate SQS for the specified Project ID. SQS must be activated before any usage such as creating credentials and queues. Activating SQS does not trigger any billing, and you can deactivate at any time.
Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time.

USAGE:
scw mnq sqs activate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a set of credentials for SQS, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.

USAGE:
scw mnq sqs create-credentials [arg=value ...]

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[name=<generated>] Name of the credentials
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (send messages to SQS queues)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from SQS queues
[permissions.can-manage] Defines whether the credentials bearer can manage the associated SQS queues
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from Queues queues
[permissions.can-manage] Defines whether the credentials bearer can manage the associated Queues queues
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Deactivate SQS for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.

USAGE:
scw mnq sqs deactivate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a set of SQS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SQS.
Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.

USAGE:
scw mnq sqs delete-credentials <sqs-credentials-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw mnq sqs get-credentials <sqs-credentials-id ...> [arg=value ...]

ARGS:
sqs-credentials-id ID of the SQS credentials to get
sqs-credentials-id ID of the Queues credentials to get
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL.
Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.

USAGE:
scw mnq sqs get-info [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.

USAGE:
scw mnq sqs list-credentials [arg=value ...]

ARGS:
[project-id] Include only SQS credentials in this Project
[project-id] Include only Queues credentials in this Project
[order-by] Order in which to return results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | all)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update a set of SQS credentials. You can update the credentials' name, or their permissions.
Update a set of Queues credentials. You can update the credentials' name, or their permissions.

USAGE:
scw mnq sqs update-credentials <sqs-credentials-id ...> [arg=value ...]

ARGS:
sqs-credentials-id ID of the SQS credentials to update
sqs-credentials-id ID of the Queues credentials to update
[name] Name of the credentials
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (send messages to SQS queues)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from SQS queues
[permissions.can-manage] Defines whether the credentials bearer can manage the associated SQS queues
[permissions.can-publish] Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues)
[permissions.can-receive] Defines whether the credentials bearer can receive messages from Queues queues
[permissions.can-manage] Defines whether the credentials bearer can manage the associated Queues queues
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams)

FLAGS:
Expand Down
18 changes: 9 additions & 9 deletions cmd/scw/testdata/test-all-usage-mnq-sqs-usage.golden
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
MnQ SQS commands.
MnQ Queues commands.

USAGE:
scw mnq sqs <command>

AVAILABLE COMMANDS:
activate Activate SQS
create-credentials Create SQS credentials
deactivate Deactivate SQS
delete-credentials Delete SQS credentials
get-credentials Get SQS credentials
get-info Get SQS info
list-credentials List SQS credentials
update-credentials Update SQS credentials
activate Activate Queues
create-credentials Create Queues credentials
deactivate Deactivate Queues
delete-credentials Delete Queues credentials
get-credentials Get Queues credentials
get-info Get Queues info
list-credentials List Queues credentials
update-credentials Update Queues credentials

FLAGS:
-h, --help help for sqs
Expand Down
6 changes: 3 additions & 3 deletions cmd/scw/testdata/test-all-usage-mnq-usage.golden
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
These APIs allow you to manage your Messaging and Queuing NATS, SQS and SNS services.
These APIs allow you to manage your Messaging and Queuing NATS, Queues and Topics and Events services.

USAGE:
scw mnq <command>

AVAILABLE COMMANDS:
nats MnQ NATS commands
sns MnQ SNS commands
sqs MnQ SQS commands
sns MnQ Topics and Events commands
sqs MnQ Queues commands

FLAGS:
-h, --help help for mnq
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-main-usage-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ AVAILABLE COMMANDS:
keymanager Key Manager API
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
mnq These APIs allow you to manage your Messaging and Queuing NATS, Queues and Topics and Events services
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
Expand Down
Loading
Loading