docs(vpc/v2): update documentation (#79)

Author: scaleway-bot

scaleway-async/scaleway_async/vpc/v1/api.py

@@ -47,15 +47,15 @@ async def list_private_networks(
     ) -> ListPrivateNetworksResponse:
         """
         List private networks
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param order_by: The sort order of the returned private networks
-        :param page: The page number for the returned private networks
-        :param page_size: The maximum number of private networks per page
-        :param name: Filter private networks with names containing this string
-        :param tags: Filter private networks with one or more matching tags
-        :param organization_id: The organization ID on which to filter the returned private networks
-        :param project_id: The project ID on which to filter the returned private networks
-        :param private_network_ids: The PrivateNetwork IDs on which to filter the returned private networks
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param order_by: The sort order of the returned private networks.
+        :param page: The page number for the returned private networks.
+        :param page_size: The maximum number of private networks per page.
+        :param name: Filter private networks with names containing this string.
+        :param tags: Filter private networks with one or more matching tags.
+        :param organization_id: The organization ID on which to filter the returned private networks.
+        :param project_id: The project ID on which to filter the returned private networks.
+        :param private_network_ids: The PrivateNetwork IDs on which to filter the returned private networks.
         :return: :class:`ListPrivateNetworksResponse <ListPrivateNetworksResponse>`
 
         Usage:
@@ -100,15 +100,15 @@ async def list_private_networks_all(
     ) -> List[PrivateNetwork]:
         """
         List private networks
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param order_by: The sort order of the returned private networks
-        :param page: The page number for the returned private networks
-        :param page_size: The maximum number of private networks per page
-        :param name: Filter private networks with names containing this string
-        :param tags: Filter private networks with one or more matching tags
-        :param organization_id: The organization ID on which to filter the returned private networks
-        :param project_id: The project ID on which to filter the returned private networks
-        :param private_network_ids: The PrivateNetwork IDs on which to filter the returned private networks
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param order_by: The sort order of the returned private networks.
+        :param page: The page number for the returned private networks.
+        :param page_size: The maximum number of private networks per page.
+        :param name: Filter private networks with names containing this string.
+        :param tags: Filter private networks with one or more matching tags.
+        :param organization_id: The organization ID on which to filter the returned private networks.
+        :param project_id: The project ID on which to filter the returned private networks.
+        :param private_network_ids: The PrivateNetwork IDs on which to filter the returned private networks.
         :return: :class:`List[ListPrivateNetworksResponse] <List[ListPrivateNetworksResponse]>`
 
         Usage:
@@ -145,11 +145,11 @@ async def create_private_network(
     ) -> PrivateNetwork:
         """
         Create a private network
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param name: The name of the private network
-        :param project_id: The project ID of the private network
-        :param tags: The private networks tags
-        :param subnets: Private network subnets CIDR
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param name: The name of the private network.
+        :param project_id: The project ID of the private network.
+        :param tags: The private networks tags.
+        :param subnets: Private network subnets CIDR.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -186,8 +186,8 @@ async def get_private_network(
     ) -> PrivateNetwork:
         """
         Get a private network
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param private_network_id: The private network id
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param private_network_id: The private network id.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -220,11 +220,11 @@ async def update_private_network(
     ) -> PrivateNetwork:
         """
         Update private network
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param private_network_id: The private network ID
-        :param name: The name of the private network
-        :param tags: The private networks tags
-        :param subnets: Private network subnets CIDR (deprecated)
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param private_network_id: The private network ID.
+        :param name: The name of the private network.
+        :param tags: The private networks tags.
+        :param subnets: Private network subnets CIDR (deprecated).
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -264,8 +264,8 @@ async def delete_private_network(
     ) -> Optional[None]:
         """
         Delete a private network
-        :param zone: Zone to target. If none is passed will use default zone from the config
-        :param private_network_id: The private network ID
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param private_network_id: The private network ID.
 
         Usage:
         ::

scaleway-async/scaleway_async/vpc/v1/types.py

@@ -32,169 +32,169 @@ class ListPrivateNetworksResponse:
 @dataclass
 class PrivateNetwork:
     """
-    Private network
+    Private network.
     """
 
     id: str
     """
-    The private network ID
+    The private network ID.
     """
 
     name: str
     """
-    The private network name
+    The private network name.
     """
 
     organization_id: str
     """
-    The private network organization
+    The private network organization.
     """
 
     project_id: str
     """
-    The private network project ID
+    The private network project ID.
     """
 
     zone: Zone
     """
-    The zone in which the private network is available
+    The zone in which the private network is available.
     """
 
     tags: List[str]
     """
-    The private network tags
+    The private network tags.
     """
 
     created_at: Optional[datetime]
     """
-    The private network creation date
+    The private network creation date.
     """
 
     updated_at: Optional[datetime]
     """
-    The last private network modification date
+    The last private network modification date.
     """
 
     subnets: List[str]
     """
-    Private network subnets CIDR
+    Private network subnets CIDR.
     """
 
 
 @dataclass
 class ListPrivateNetworksRequest:
     zone: Optional[Zone]
     """
-    Zone to target. If none is passed will use default zone from the config
+    Zone to target. If none is passed will use default zone from the config.
     """
 
     order_by: Optional[ListPrivateNetworksRequestOrderBy]
     """
-    The sort order of the returned private networks
+    The sort order of the returned private networks.
     """
 
     page: Optional[int]
     """
-    The page number for the returned private networks
+    The page number for the returned private networks.
     """
 
     page_size: Optional[int]
     """
-    The maximum number of private networks per page
+    The maximum number of private networks per page.
     """
 
     name: Optional[str]
     """
-    Filter private networks with names containing this string
+    Filter private networks with names containing this string.
     """
 
     tags: Optional[List[str]]
     """
-    Filter private networks with one or more matching tags
+    Filter private networks with one or more matching tags.
     """
 
     organization_id: Optional[str]
     """
-    The organization ID on which to filter the returned private networks
+    The organization ID on which to filter the returned private networks.
     """
 
     project_id: Optional[str]
     """
-    The project ID on which to filter the returned private networks
+    The project ID on which to filter the returned private networks.
     """
 
     private_network_ids: Optional[List[str]]
     """
-    The PrivateNetwork IDs on which to filter the returned private networks
+    The PrivateNetwork IDs on which to filter the returned private networks.
     """
 
 
 @dataclass
 class CreatePrivateNetworkRequest:
     zone: Optional[Zone]
     """
-    Zone to target. If none is passed will use default zone from the config
+    Zone to target. If none is passed will use default zone from the config.
     """
 
     name: Optional[str]
     """
-    The name of the private network
+    The name of the private network.
     """
 
     project_id: Optional[str]
     """
-    The project ID of the private network
+    The project ID of the private network.
     """
 
     tags: Optional[List[str]]
     """
-    The private networks tags
+    The private networks tags.
     """
 
     subnets: Optional[List[str]]
     """
-    Private network subnets CIDR
+    Private network subnets CIDR.
     """
 
 
 @dataclass
 class GetPrivateNetworkRequest:
     zone: Optional[Zone]
     """
-    Zone to target. If none is passed will use default zone from the config
+    Zone to target. If none is passed will use default zone from the config.
     """
 
     private_network_id: str
     """
-    The private network id
+    The private network id.
     """
 
 
 @dataclass
 class UpdatePrivateNetworkRequest:
     zone: Optional[Zone]
     """
-    Zone to target. If none is passed will use default zone from the config
+    Zone to target. If none is passed will use default zone from the config.
     """
 
     private_network_id: str
     """
-    The private network ID
+    The private network ID.
     """
 
     name: Optional[str]
     """
-    The name of the private network
+    The name of the private network.
     """
 
     tags: Optional[List[str]]
     """
-    The private networks tags
+    The private networks tags.
     """
 
     subnets: Optional[List[str]]
     """
-    Private network subnets CIDR (deprecated)
+    Private network subnets CIDR (deprecated).
     :deprecated
     """
 
@@ -203,10 +203,10 @@ class UpdatePrivateNetworkRequest:
 class DeletePrivateNetworkRequest:
     zone: Optional[Zone]
     """
-    Zone to target. If none is passed will use default zone from the config
+    Zone to target. If none is passed will use default zone from the config.
     """
 
     private_network_id: str
     """
-    The private network ID
+    The private network ID.
     """