Skip to content

docs(mongodb): add documentation #715

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
Oct 25, 2024
Merged

docs(mongodb): add documentation #715

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
52 changes: 26 additions & 26 deletions scaleway-async/scaleway_async/mongodb/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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>`
Expand Down Expand Up @@ -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]>`
Expand Down Expand Up @@ -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>`
Expand Down Expand Up @@ -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>`
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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>`
Expand Down Expand Up @@ -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>`

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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>`
Expand Down
48 changes: 24 additions & 24 deletions scaleway-async/scaleway_async/mongodb/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ class EndpointPrivateNetworkDetails:

private_network_id: str
"""
UUID of the private network.
UUID of the Private Network.
"""


Expand All @@ -125,7 +125,7 @@ class EndpointPublicDetails:
class EndpointSpecPrivateNetworkDetails:
private_network_id: str
"""
UUID of the private network.
UUID of the Private Network.
"""


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand All @@ -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.
"""


Expand Down Expand Up @@ -453,7 +453,7 @@ class Snapshot:

region: Region
"""
Region of this snapshot.
Region of the snapshot.
"""

expires_at: Optional[datetime]
Expand All @@ -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.
"""


Expand All @@ -489,7 +489,7 @@ class User:
class Version:
version: str
"""
MongoDB™ engine version.
MongoDB® engine version.
"""

available_settings: List[Setting]
Expand All @@ -515,7 +515,7 @@ class RestoreSnapshotRequestVolumeDetails:
class CreateInstanceRequest:
version: str
"""
Version of the MongoDB™ engine.
Version of the MongoDB® engine.
"""

node_number: int
Expand Down Expand Up @@ -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]
Expand All @@ -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.
"""


Expand Down Expand Up @@ -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]
Expand All @@ -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.
"""


Expand Down Expand Up @@ -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.
"""


Expand Down
Loading