docs(mongodb): add documentation (scaleway#715)

Author: scaleway-bot

scaleway-async/scaleway_async/mongodb/v1alpha1/api.py

@@ -67,7 +67,7 @@
 
 class MongodbV1Alpha1API(API):
     """
-    This API allows you to manage your Managed Databases for MongoDB.
+    This API allows you to manage your Managed Databases for MongoDB®.
     """
 
     async def list_node_types(
@@ -152,7 +152,7 @@ async def list_versions(
         page_size: Optional[int] = None,
     ) -> ListVersionsResponse:
         """
-        List available MongoDB™ versions.
+        List available MongoDB® versions.
         :param region: Region to target. If none is passed will use default region from the config.
         :param version:
         :param page:
@@ -191,7 +191,7 @@ async def list_versions_all(
         page_size: Optional[int] = None,
     ) -> List[Version]:
         """
-        List available MongoDB™ versions.
+        List available MongoDB® versions.
         :param region: Region to target. If none is passed will use default region from the config.
         :param version:
         :param page:
@@ -229,14 +229,14 @@ async def list_instances(
         page_size: Optional[int] = None,
     ) -> ListInstancesResponse:
         """
-        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 MongoDB® Database Instances.
+        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.
         :param region: Region to target. If none is passed will use default region from the config.
         :param tags: List Database Instances that have a given tag.
         :param name: Lists Database Instances that match a name pattern.
         :param order_by: Criteria to use when ordering Database Instance listings.
-        :param organization_id: Organization ID the Database Instance belongs to.
-        :param project_id: Project ID to list the Database Instance of.
+        :param organization_id: Organization ID of the Database Instance.
+        :param project_id: Project ID.
         :param page:
         :param page_size:
         :return: :class:`ListInstancesResponse <ListInstancesResponse>`
@@ -282,14 +282,14 @@ async def list_instances_all(
         page_size: Optional[int] = None,
     ) -> List[Instance]:
         """
-        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 MongoDB® Database Instances.
+        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.
         :param region: Region to target. If none is passed will use default region from the config.
         :param tags: List Database Instances that have a given tag.
         :param name: Lists Database Instances that match a name pattern.
         :param order_by: Criteria to use when ordering Database Instance listings.
-        :param organization_id: Organization ID the Database Instance belongs to.
-        :param project_id: Project ID to list the Database Instance of.
+        :param organization_id: Organization ID of the Database Instance.
+        :param project_id: Project ID.
         :param page:
         :param page_size:
         :return: :class:`List[Instance] <List[Instance]>`
@@ -323,8 +323,8 @@ async def get_instance(
         region: Optional[Region] = None,
     ) -> 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.
+        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.
         :param instance_id: UUID of the Database Instance.
         :param region: Region to target. If none is passed will use default region from the config.
         :return: :class:`Instance <Instance>`
@@ -360,8 +360,8 @@ async def wait_for_instance(
         ] = None,
     ) -> 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.
+        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.
         :param instance_id: UUID of the Database Instance.
         :param region: Region to target. If none is passed will use default region from the config.
         :return: :class:`Instance <Instance>`
@@ -405,9 +405,9 @@ async def create_instance(
         endpoints: Optional[List[EndpointSpec]] = None,
     ) -> Instance:
         """
-        Create a MongoDB™ Database Instance.
-        Create a new MongoDB™ Database Instance.
-        :param version: Version of the MongoDB™ engine.
+        Create a MongoDB® Database Instance.
+        Create a new MongoDB® Database Instance.
+        :param version: Version of the MongoDB® engine.
         :param node_number: Number of node to use for the Database Instance.
         :param node_type: Type of node to use for the Database Instance.
         :param user_name: Username created when the Database Instance is created.
@@ -469,8 +469,8 @@ async def update_instance(
         tags: Optional[List[str]] = None,
     ) -> Instance:
         """
-        Update a MongoDB™ Database Instance.
-        Update the parameters of a MongoDB™ Database Instance.
+        Update a MongoDB® Database Instance.
+        Update the parameters of a MongoDB® Database Instance.
         :param instance_id: UUID of the Database Instance to update.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the Database Instance.
@@ -514,8 +514,8 @@ async def delete_instance(
         region: Optional[Region] = None,
     ) -> 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 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.
         :param instance_id: UUID of the Database Instance to delete.
         :param region: Region to target. If none is passed will use default region from the config.
         :return: :class:`Instance <Instance>`
@@ -553,7 +553,7 @@ async def upgrade_instance(
         Upgrade your current Database Instance specifications like volume size.
         :param instance_id: UUID of the Database Instance you want to upgrade.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param volume_size: Increase your block storage volume size.
+        :param volume_size: Increase your Block Storage volume size.
         One-Of ('upgrade_target'): at most one of 'volume_size' could be set.
         :return: :class:`Instance <Instance>`
 
@@ -862,7 +862,7 @@ async def list_snapshots(
         List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param region: Region to target. If none is passed will use default region from the config.
         :param instance_id: Instance ID the snapshots belongs to.
-        :param name: Lists Database snapshots that match a name pattern.
+        :param name: Lists database snapshots that match a name pattern.
         :param order_by: Criteria to use when ordering snapshot listings.
         :param organization_id: Organization ID the snapshots belongs to.
         :param project_id: Project ID to list the snapshots of.
@@ -915,7 +915,7 @@ async def list_snapshots_all(
         List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param region: Region to target. If none is passed will use default region from the config.
         :param instance_id: Instance ID the snapshots belongs to.
-        :param name: Lists Database snapshots that match a name pattern.
+        :param name: Lists database snapshots that match a name pattern.
         :param order_by: Criteria to use when ordering snapshot listings.
         :param organization_id: Organization ID the snapshots belongs to.
         :param project_id: Project ID to list the snapshots of.
@@ -953,7 +953,7 @@ async def delete_snapshot(
     ) -> Snapshot:
         """
         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.
         :param snapshot_id: UUID of the snapshot.
         :param region: Region to target. If none is passed will use default region from the config.
         :return: :class:`Snapshot <Snapshot>`

scaleway-async/scaleway_async/mongodb/v1alpha1/types.py

@@ -112,7 +112,7 @@ class EndpointPrivateNetworkDetails:
 
     private_network_id: str
     """
-    UUID of the private network.
+    UUID of the Private Network.
     """
 
 
@@ -125,7 +125,7 @@ class EndpointPublicDetails:
 class EndpointSpecPrivateNetworkDetails:
     private_network_id: str
     """
-    UUID of the private network.
+    UUID of the Private Network.
     """
 
 
@@ -196,17 +196,17 @@ class NodeTypeVolumeType:
 
     description: str
     """
-    The description of the Volume.
+    The description of the volume.
     """
 
     min_size: int
     """
-    Mimimum size required for the Volume.
+    Mimimum size required for the volume.
     """
 
     max_size: int
     """
-    Maximum size required for the Volume.
+    Maximum size required for the volume.
     """
 
     chunk_size: int
@@ -322,7 +322,7 @@ class Instance:
 
     version: str
     """
-    MongoDB™ engine version of the Database Instance.
+    MongoDB® engine version of the Database Instance.
     """
 
     tags: List[str]
@@ -370,12 +370,12 @@ class Instance:
 class NodeType:
     name: str
     """
-    Node Type name identifier.
+    Node type name identifier.
     """
 
     stock_status: NodeTypeStock
     """
-    Current stock status for the Node Type.
+    Current stock status for the node type.
     """
 
     description: str
@@ -395,22 +395,22 @@ class NodeType:
 
     available_volume_types: List[NodeTypeVolumeType]
     """
-    Available storage options for the Node Type.
+    Available storage options for the node type.
     """
 
     disabled: bool
     """
-    The Node Type is currently disabled.
+    The node type is currently disabled.
     """
 
     beta: bool
     """
-    The Node Type is currently in beta.
+    The node type is currently in beta.
     """
 
     instance_range: str
     """
-    Instance range associated with the NodeType offer.
+    Instance range associated with the node type offer.
     """
 
 
@@ -453,7 +453,7 @@ class Snapshot:
 
     region: Region
     """
-    Region of this snapshot.
+    Region of the snapshot.
     """
 
     expires_at: Optional[datetime]
@@ -473,7 +473,7 @@ class Snapshot:
 
     volume_type: Optional[SnapshotVolumeType]
     """
-    Type of volume where data is stored sbs_5k or sbs_15k.
+    Type of volume where data is stored - sbs_5k or sbs_15k.
     """
 
 
@@ -489,7 +489,7 @@ class User:
 class Version:
     version: str
     """
-    MongoDB™ engine version.
+    MongoDB® engine version.
     """
 
     available_settings: List[Setting]
@@ -515,7 +515,7 @@ class RestoreSnapshotRequestVolumeDetails:
 class CreateInstanceRequest:
     version: str
     """
-    Version of the MongoDB™ engine.
+    Version of the MongoDB® engine.
     """
 
     node_number: int
@@ -681,12 +681,12 @@ class ListInstancesRequest:
 
     organization_id: Optional[str]
     """
-    Organization ID the Database Instance belongs to.
+    Organization ID of the Database Instance.
     """
 
     project_id: Optional[str]
     """
-    Project ID to list the Database Instance of.
+    Project ID.
     """
 
     page: Optional[int]
@@ -703,7 +703,7 @@ class ListInstancesResponse:
 
     total_count: int
     """
-    Total count of Database Instances available in a Organization or Project.
+    Total count of Database Instances available in an Organization or Project.
     """
 
 
@@ -751,7 +751,7 @@ class ListSnapshotsRequest:
 
     name: Optional[str]
     """
-    Lists Database snapshots that match a name pattern.
+    Lists database snapshots that match a name pattern.
     """
 
     order_by: Optional[ListSnapshotsRequestOrderBy]
@@ -778,12 +778,12 @@ class ListSnapshotsRequest:
 class ListSnapshotsResponse:
     snapshots: List[Snapshot]
     """
-    List of all Database Snapshots available in an Organization or Project.
+    List of all database snapshots available in an Organization or Project.
     """
 
     total_count: int
     """
-    Total count of Database Snapshots available in a Organization or Project.
+    Total count of database snapshots available in a Organization or Project.
     """
 
 
@@ -845,12 +845,12 @@ class ListVersionsRequest:
 class ListVersionsResponse:
     versions: List[Version]
     """
-    Available MongoDB™ engine version.
+    Available MongoDB® engine version.
     """
 
     total_count: int
     """
-    Total count of MongoDB™ engine version available.
+    Total count of MongoDB® engine version available.
     """