gcore 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

gcore/resources/cloud/registries/users.py

@@ -21,6 +21,7 @@ from ....types.cloud.registries import user_create_params, user_update_params, u
 from ....types.cloud.registries.registry_user import RegistryUser
 from ....types.cloud.registries.registry_user_list import RegistryUserList
 from ....types.cloud.registries.registry_user_created import RegistryUserCreated
+from ....types.cloud.registries.user_refresh_secret_response import UserRefreshSecretResponse
 
 __all__ = ["UsersResource", "AsyncUsersResource"]
 
@@ -61,9 +62,9 @@ class UsersResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> RegistryUser:
+    ) -> RegistryUserCreated:
         """
-        Create a user
+        Create a new user for accessing the container registry.
 
         Args:
           duration: User account operating time, days
@@ -101,7 +102,7 @@ class UsersResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=RegistryUser,
+            cast_to=RegistryUserCreated,
         )
 
     def update(
@@ -121,7 +122,7 @@ class UsersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUser:
         """
-        Update a user
+        Update the configuration of a specific registry user.
 
         Args:
           duration: User account operating time, days
@@ -169,7 +170,7 @@ class UsersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUserList:
         """
-        Get user list
+        List all users with access to the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -207,7 +208,7 @@ class UsersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a user
+        Delete a specific user from the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -246,7 +247,7 @@ class UsersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUserCreated:
         """
-        Batch create users
+        Create multiple users for accessing the container registry in a single request.
 
         Args:
           users: Set of users
@@ -285,9 +286,9 @@ class UsersResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> UserRefreshSecretResponse:
         """
-        Refresh a secret
+        Generate a new secret for a specific registry user.
 
         Args:
           extra_headers: Send extra headers
@@ -302,13 +303,12 @@ class UsersResource(SyncAPIResource):
             project_id = self._client._get_cloud_project_id_path_param()
         if region_id is None:
             region_id = self._client._get_cloud_region_id_path_param()
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/cloud/v1/registries/{project_id}/{region_id}/{registry_id}/users/{user_id}/refresh_secret",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=UserRefreshSecretResponse,
         )
 
 
@@ -348,9 +348,9 @@ class AsyncUsersResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> RegistryUser:
+    ) -> RegistryUserCreated:
         """
-        Create a user
+        Create a new user for accessing the container registry.
 
         Args:
           duration: User account operating time, days
@@ -388,7 +388,7 @@ class AsyncUsersResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=RegistryUser,
+            cast_to=RegistryUserCreated,
         )
 
     async def update(
@@ -408,7 +408,7 @@ class AsyncUsersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUser:
         """
-        Update a user
+        Update the configuration of a specific registry user.
 
         Args:
           duration: User account operating time, days
@@ -456,7 +456,7 @@ class AsyncUsersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUserList:
         """
-        Get user list
+        List all users with access to the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -494,7 +494,7 @@ class AsyncUsersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a user
+        Delete a specific user from the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -533,7 +533,7 @@ class AsyncUsersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryUserCreated:
         """
-        Batch create users
+        Create multiple users for accessing the container registry in a single request.
 
         Args:
           users: Set of users
@@ -572,9 +572,9 @@ class AsyncUsersResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> UserRefreshSecretResponse:
         """
-        Refresh a secret
+        Generate a new secret for a specific registry user.
 
         Args:
           extra_headers: Send extra headers
@@ -589,13 +589,12 @@ class AsyncUsersResource(AsyncAPIResource):
             project_id = self._client._get_cloud_project_id_path_param()
         if region_id is None:
             region_id = self._client._get_cloud_region_id_path_param()
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/cloud/v1/registries/{project_id}/{region_id}/{registry_id}/users/{user_id}/refresh_secret",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=UserRefreshSecretResponse,
         )
 
 

gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py

@@ -76,7 +76,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           type: Must be 'external'
@@ -112,7 +112,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           subnet_id: Reserved fixed IP will be allocated in this subnet
@@ -149,7 +149,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           network_id: Reserved fixed IP will be allocated in a subnet of this network
@@ -188,7 +188,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           ip_address: Reserved fixed IP will be allocated the given IP address
@@ -225,7 +225,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           port_id: Port ID to make a reserved fixed IP (for example, `vip_port_id` of the Load
@@ -315,7 +315,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[ReservedFixedIP]:
         """
-        List reserved fixed IPs
+        List all reserved fixed IPs in the specified project and region.
 
         Args:
           available_only: Set to true if the response should only list IP addresses that are not attached
@@ -334,8 +334,8 @@ class ReservedFixedIPsResource(SyncAPIResource):
           offset: Offset value is used to exclude the first set of records from the result
 
           order_by: Ordering reserved fixed IP list result by name, status, `updated_at`,
-              `created_at` or `fixed_ip_address` fields of the reserved fixed IP and
-              directions (status.asc), default is "`fixed_ip_address`.asc"
+              `created_at` or `fixed_ip_address` fields and directions (status.asc), default
+              is "`fixed_ip_address`.asc"
 
           vip_only: Set to true if the response should only list VIPs
 
@@ -391,7 +391,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Delete reserved fixed ip
+        Delete a specific reserved fixed IP and all its associated resources.
 
         Args:
           extra_headers: Send extra headers
@@ -430,7 +430,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Get reserved fixed IP
+        Get detailed information about a specific reserved fixed IP.
 
         Args:
           extra_headers: Send extra headers
@@ -497,7 +497,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           type: Must be 'external'
@@ -533,7 +533,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           subnet_id: Reserved fixed IP will be allocated in this subnet
@@ -570,7 +570,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           network_id: Reserved fixed IP will be allocated in a subnet of this network
@@ -609,7 +609,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           ip_address: Reserved fixed IP will be allocated the given IP address
@@ -646,7 +646,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Create reserved fixed IP
+        Create a new reserved fixed IP with the specified configuration.
 
         Args:
           port_id: Port ID to make a reserved fixed IP (for example, `vip_port_id` of the Load
@@ -736,7 +736,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[ReservedFixedIP, AsyncOffsetPage[ReservedFixedIP]]:
         """
-        List reserved fixed IPs
+        List all reserved fixed IPs in the specified project and region.
 
         Args:
           available_only: Set to true if the response should only list IP addresses that are not attached
@@ -755,8 +755,8 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
           offset: Offset value is used to exclude the first set of records from the result
 
           order_by: Ordering reserved fixed IP list result by name, status, `updated_at`,
-              `created_at` or `fixed_ip_address` fields of the reserved fixed IP and
-              directions (status.asc), default is "`fixed_ip_address`.asc"
+              `created_at` or `fixed_ip_address` fields and directions (status.asc), default
+              is "`fixed_ip_address`.asc"
 
           vip_only: Set to true if the response should only list VIPs
 
@@ -812,7 +812,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
         """
-        Delete reserved fixed ip
+        Delete a specific reserved fixed IP and all its associated resources.
 
         Args:
           extra_headers: Send extra headers
@@ -851,7 +851,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Get reserved fixed IP
+        Get detailed information about a specific reserved fixed IP.
 
         Args:
           extra_headers: Send extra headers

gcore/resources/cloud/reserved_fixed_ips/vip.py

@@ -63,7 +63,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CandidatePortList:
         """
-        List instance ports that are available for connecting to VIP
+        List all instance ports that are available for connecting to a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -102,7 +102,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        List instance ports that share VIP
+        List all instance ports that share a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -142,7 +142,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Replace ports that share VIP
+        Replace the list of instance ports that share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -187,7 +187,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Switch VIP status of reserved fixed IP
+        Update the VIP status of a reserved fixed IP.
 
         Args:
           is_vip: If reserved fixed IP should be a VIP
@@ -230,7 +230,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Add ports that share VIP
+        Add instance ports to share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -295,7 +295,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CandidatePortList:
         """
-        List instance ports that are available for connecting to VIP
+        List all instance ports that are available for connecting to a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -334,7 +334,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        List instance ports that share VIP
+        List all instance ports that share a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -374,7 +374,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Replace ports that share VIP
+        Replace the list of instance ports that share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -419,7 +419,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Switch VIP status of reserved fixed IP
+        Update the VIP status of a reserved fixed IP.
 
         Args:
           is_vip: If reserved fixed IP should be a VIP
@@ -462,7 +462,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Add ports that share VIP
+        Add instance ports to share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP