Skip to content

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

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.

Sign up for GitHub

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
Dec 9, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 53 additions & 53 deletions scaleway-async/scaleway_async/mnq/v1beta1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@

class MnqV1Beta1NatsAPI(API):
"""
This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
This API allows you to manage Scaleway NATS accounts.
"""

async def create_nats_account(
Expand Down Expand Up @@ -506,7 +506,7 @@ async def list_nats_credentials_all(

class MnqV1Beta1SnsAPI(API):
"""
This API allows you to manage your Scaleway Messaging and Queuing SNS brokers.
This API allows you to manage your Scaleway Topics and Events.
"""

async def activate_sns(
Expand All @@ -516,10 +516,10 @@ async def activate_sns(
project_id: Optional[str] = None,
) -> SnsInfo:
"""
Activate SNS.
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.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project on which to activate the SNS service.
:param project_id: Project on which to activate the Topics and Events service.
:return: :class:`SnsInfo <SnsInfo>`

Usage:
Expand Down Expand Up @@ -554,10 +554,10 @@ async def get_sns_info(
project_id: Optional[str] = None,
) -> SnsInfo:
"""
Get SNS info.
Retrieve the SNS information of the specified Project ID. Informations include the activation status and the SNS API endpoint URL.
Get Topics and Events info.
Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project to retrieve SNS info from.
:param project_id: Project to retrieve Topics and Events info from.
:return: :class:`SnsInfo <SnsInfo>`

Usage:
Expand Down Expand Up @@ -588,10 +588,10 @@ async def deactivate_sns(
project_id: Optional[str] = None,
) -> SnsInfo:
"""
Deactivate SNS.
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.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project on which to deactivate the SNS service.
:param project_id: Project on which to deactivate the Topics and Events service.
:return: :class:`SnsInfo <SnsInfo>`

Usage:
Expand Down Expand Up @@ -628,10 +628,10 @@ async def create_sns_credentials(
permissions: Optional[SnsPermissions] = None,
) -> SnsCredentials:
"""
Create SNS credentials.
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 Topics and Events credentials.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project containing the SNS credentials.
:param project_id: Project containing the Topics and Events credentials.
:param name: Name of the credentials.
:param permissions: Permissions associated with these credentials.
:return: :class:`SnsCredentials <SnsCredentials>`
Expand Down Expand Up @@ -670,8 +670,8 @@ async def delete_sns_credentials(
region: Optional[Region] = None,
) -> None:
"""
Delete SNS credentials.
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 Topics and Events credentials.
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.
:param sns_credentials_id: ID of the credentials to delete.
:param region: Region to target. If none is passed will use default region from the config.

Expand Down Expand Up @@ -706,9 +706,9 @@ async def update_sns_credentials(
permissions: Optional[SnsPermissions] = None,
) -> SnsCredentials:
"""
Update SNS credentials.
Update a set of SNS credentials. You can update the credentials' name, or their permissions.
:param sns_credentials_id: ID of the SNS credentials to update.
Update Topics and Events credentials.
Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.
:param sns_credentials_id: ID of the Topics and Events credentials to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the credentials.
:param permissions: Permissions associated with these credentials.
Expand Down Expand Up @@ -753,9 +753,9 @@ async def get_sns_credentials(
region: Optional[Region] = None,
) -> SnsCredentials:
"""
Get SNS credentials.
Get Topics and Events credentials.
Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
:param sns_credentials_id: ID of the SNS credentials to get.
:param sns_credentials_id: ID of the Topics and Events credentials to get.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`SnsCredentials <SnsCredentials>`

Expand Down Expand Up @@ -792,10 +792,10 @@ async def list_sns_credentials(
order_by: Optional[ListSnsCredentialsRequestOrderBy] = None,
) -> ListSnsCredentialsResponse:
"""
List SNS credentials.
List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List Topics and Events credentials.
List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Include only SNS credentials in this Project.
:param project_id: Include only Topics and Events credentials in this Project.
:param page: Page number to return.
:param page_size: Maximum number of credentials to return per page.
:param order_by: Order in which to return results.
Expand Down Expand Up @@ -835,10 +835,10 @@ async def list_sns_credentials_all(
order_by: Optional[ListSnsCredentialsRequestOrderBy] = None,
) -> List[SnsCredentials]:
"""
List SNS credentials.
List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List Topics and Events credentials.
List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Include only SNS credentials in this Project.
:param project_id: Include only Topics and Events credentials in this Project.
:param page: Page number to return.
:param page_size: Maximum number of credentials to return per page.
:param order_by: Order in which to return results.
Expand Down Expand Up @@ -866,7 +866,7 @@ async def list_sns_credentials_all(

class MnqV1Beta1SqsAPI(API):
"""
This API allows you to manage your Scaleway Messaging and Queuing SQS brokers.
This API allows you to manage your Scaleway Queues.
"""

async def activate_sqs(
Expand All @@ -876,10 +876,10 @@ async def activate_sqs(
project_id: Optional[str] = None,
) -> SqsInfo:
"""
Activate SQS.
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.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project on which to activate the SQS service.
:param project_id: Project on which to activate the Queues service.
:return: :class:`SqsInfo <SqsInfo>`

Usage:
Expand Down Expand Up @@ -914,10 +914,10 @@ async def get_sqs_info(
project_id: Optional[str] = None,
) -> SqsInfo:
"""
Get SQS info.
Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL.
Get Queues info.
Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project to retrieve SQS info from.
:param project_id: Project to retrieve Queues info from.
:return: :class:`SqsInfo <SqsInfo>`

Usage:
Expand Down Expand Up @@ -948,10 +948,10 @@ async def deactivate_sqs(
project_id: Optional[str] = None,
) -> SqsInfo:
"""
Deactivate SQS.
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.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project on which to deactivate the SQS service.
:param project_id: Project on which to deactivate the Queues service.
:return: :class:`SqsInfo <SqsInfo>`

Usage:
Expand Down Expand Up @@ -988,10 +988,10 @@ async def create_sqs_credentials(
permissions: Optional[SqsPermissions] = None,
) -> SqsCredentials:
"""
Create SQS credentials.
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 Queues credentials.
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.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Project containing the SQS credentials.
:param project_id: Project containing the Queues credentials.
:param name: Name of the credentials.
:param permissions: Permissions associated with these credentials.
:return: :class:`SqsCredentials <SqsCredentials>`
Expand Down Expand Up @@ -1030,8 +1030,8 @@ async def delete_sqs_credentials(
region: Optional[Region] = None,
) -> None:
"""
Delete SQS credentials.
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 Queues credentials.
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.
:param sqs_credentials_id: ID of the credentials to delete.
:param region: Region to target. If none is passed will use default region from the config.

Expand Down Expand Up @@ -1066,9 +1066,9 @@ async def update_sqs_credentials(
permissions: Optional[SqsPermissions] = None,
) -> SqsCredentials:
"""
Update SQS credentials.
Update a set of SQS credentials. You can update the credentials' name, or their permissions.
:param sqs_credentials_id: ID of the SQS credentials to update.
Update Queues credentials.
Update a set of Queues credentials. You can update the credentials' name, or their permissions.
:param sqs_credentials_id: ID of the Queues credentials to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the credentials.
:param permissions: Permissions associated with these credentials.
Expand Down Expand Up @@ -1113,9 +1113,9 @@ async def get_sqs_credentials(
region: Optional[Region] = None,
) -> SqsCredentials:
"""
Get SQS credentials.
Get Queues credentials.
Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
:param sqs_credentials_id: ID of the SQS credentials to get.
:param sqs_credentials_id: ID of the Queues credentials to get.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`SqsCredentials <SqsCredentials>`

Expand Down Expand Up @@ -1152,10 +1152,10 @@ async def list_sqs_credentials(
order_by: Optional[ListSqsCredentialsRequestOrderBy] = None,
) -> ListSqsCredentialsResponse:
"""
List SQS credentials.
List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List Queues credentials.
List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Include only SQS credentials in this Project.
:param project_id: Include only Queues credentials in this Project.
:param page: Page number to return.
:param page_size: Maximum number of credentials to return per page.
:param order_by: Order in which to return results.
Expand Down Expand Up @@ -1195,10 +1195,10 @@ async def list_sqs_credentials_all(
order_by: Optional[ListSqsCredentialsRequestOrderBy] = None,
) -> List[SqsCredentials]:
"""
List SQS credentials.
List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
List Queues credentials.
List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: Include only SQS credentials in this Project.
:param project_id: Include only Queues credentials in this Project.
:param page: Page number to return.
:param page_size: Maximum number of credentials to return per page.
:param order_by: Order in which to return results.
Expand Down
Loading
Loading