gcore 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

gcore/resources/cloud/projects.py

@@ -60,12 +60,13 @@ class ProjectsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
-        """Create project
+        """Create a new project for a client.
 
-        Args:
-          name: Unique project name for a client.
+        Project management must be enabled to perform
+        this operation.
 
-        Each client always has one "default" project.
+        Args:
+          name: Unique project name for a client. Each client always has one "default" project.
 
           client_id: ID associated with the client.
 
@@ -114,8 +115,10 @@ class ProjectsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[Project]:
-        """
-        List projects
+        """Retrieve a list of projects for a client.
+
+        Results can be filtered by name and
+        ordered by various fields.
 
         Args:
           client_id: Client ID filter for administrators.
@@ -172,9 +175,11 @@ class ProjectsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        All cloud resources in all regions that belong to the project will be deleted
-        and will not be recoverable
+        """Delete a project and all its associated cloud resources across all regions.
+
+        This
+        operation is irreversible and cannot be undone. Default projects cannot be
+        deleted.
 
         Args:
           extra_headers: Send extra headers
@@ -207,7 +212,7 @@ class ProjectsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
         """
-        Get Project
+        Retrieve detailed information about a specific project.
 
         Args:
           extra_headers: Send extra headers
@@ -241,8 +246,10 @@ class ProjectsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
-        """
-        Update Project
+        """Update project name and description.
+
+        Project management must be enabled to
+        perform this operation.
 
         Args:
           name: Name of the entity, following a specific format.
@@ -309,12 +316,13 @@ class AsyncProjectsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
-        """Create project
+        """Create a new project for a client.
 
-        Args:
-          name: Unique project name for a client.
+        Project management must be enabled to perform
+        this operation.
 
-        Each client always has one "default" project.
+        Args:
+          name: Unique project name for a client. Each client always has one "default" project.
 
           client_id: ID associated with the client.
 
@@ -363,8 +371,10 @@ class AsyncProjectsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[Project, AsyncOffsetPage[Project]]:
-        """
-        List projects
+        """Retrieve a list of projects for a client.
+
+        Results can be filtered by name and
+        ordered by various fields.
 
         Args:
           client_id: Client ID filter for administrators.
@@ -421,9 +431,11 @@ class AsyncProjectsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        All cloud resources in all regions that belong to the project will be deleted
-        and will not be recoverable
+        """Delete a project and all its associated cloud resources across all regions.
+
+        This
+        operation is irreversible and cannot be undone. Default projects cannot be
+        deleted.
 
         Args:
           extra_headers: Send extra headers
@@ -456,7 +468,7 @@ class AsyncProjectsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
         """
-        Get Project
+        Retrieve detailed information about a specific project.
 
         Args:
           extra_headers: Send extra headers
@@ -490,8 +502,10 @@ class AsyncProjectsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Project:
-        """
-        Update Project
+        """Update project name and description.
+
+        Project management must be enabled to
+        perform this operation.
 
         Args:
           name: Name of the entity, following a specific format.

gcore/resources/cloud/quotas/quotas.py

@@ -63,7 +63,7 @@ class QuotasResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetAllResponse:
-        """Get combined client quotas, regional and global."""
+        """Get combined client quotas, including both regional and global quotas."""
         return self._get(
             "/cloud/v2/client_quotas",
             options=make_request_options(
@@ -85,7 +85,7 @@ class QuotasResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetByRegionResponse:
         """
-        Get a quota by region
+        Get quotas for a specific region and client.
 
         Args:
           client_id: Client ID
@@ -122,7 +122,7 @@ class QuotasResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetGlobalResponse:
         """
-        Get global quota
+        Get global quotas for a specific client.
 
         Args:
           client_id: Client ID
@@ -178,7 +178,7 @@ class AsyncQuotasResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetAllResponse:
-        """Get combined client quotas, regional and global."""
+        """Get combined client quotas, including both regional and global quotas."""
         return await self._get(
             "/cloud/v2/client_quotas",
             options=make_request_options(
@@ -200,7 +200,7 @@ class AsyncQuotasResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetByRegionResponse:
         """
-        Get a quota by region
+        Get quotas for a specific region and client.
 
         Args:
           client_id: Client ID
@@ -237,7 +237,7 @@ class AsyncQuotasResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> QuotaGetGlobalResponse:
         """
-        Get global quota
+        Get global quotas for a specific client.
 
         Args:
           client_id: Client ID

gcore/resources/cloud/quotas/requests.py

@@ -60,7 +60,7 @@ class RequestsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Create request to change quotas
+        Create a request to change current quotas.
 
         Args:
           description: Describe the reason, in general terms.
@@ -108,7 +108,7 @@ class RequestsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[RequestListResponse]:
         """
-        Returns a list of sent requests to change current quotas and their statuses
+        Get a list of sent requests to change current quotas and their statuses.
 
         Args:
           limit: Optional. Limit the number of returned items
@@ -158,7 +158,7 @@ class RequestsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete request to change quotas
+        Delete a specific quota limit request.
 
         Args:
           request_id: LimitRequest ID
@@ -194,7 +194,7 @@ class RequestsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RequestGetResponse:
         """
-        Get request to change quota limits.
+        Get detailed information about a specific quota limit request.
 
         Args:
           request_id: LimitRequest ID
@@ -252,7 +252,7 @@ class AsyncRequestsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Create request to change quotas
+        Create a request to change current quotas.
 
         Args:
           description: Describe the reason, in general terms.
@@ -300,7 +300,7 @@ class AsyncRequestsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[RequestListResponse, AsyncOffsetPage[RequestListResponse]]:
         """
-        Returns a list of sent requests to change current quotas and their statuses
+        Get a list of sent requests to change current quotas and their statuses.
 
         Args:
           limit: Optional. Limit the number of returned items
@@ -350,7 +350,7 @@ class AsyncRequestsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete request to change quotas
+        Delete a specific quota limit request.
 
         Args:
           request_id: LimitRequest ID
@@ -386,7 +386,7 @@ class AsyncRequestsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RequestGetResponse:
         """
-        Get request to change quota limits.
+        Get detailed information about a specific quota limit request.
 
         Args:
           request_id: LimitRequest ID

gcore/resources/cloud/registries/artifacts.py

@@ -54,7 +54,7 @@ class ArtifactsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryArtifactList:
         """
-        List artifacts
+        List all artifacts in a specific repository.
 
         Args:
           extra_headers: Send extra headers
@@ -95,7 +95,7 @@ class ArtifactsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete an artifact
+        Delete a specific artifact from a repository.
 
         Args:
           extra_headers: Send extra headers
@@ -159,7 +159,7 @@ class AsyncArtifactsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryArtifactList:
         """
-        List artifacts
+        List all artifacts in a specific repository.
 
         Args:
           extra_headers: Send extra headers
@@ -200,7 +200,7 @@ class AsyncArtifactsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete an artifact
+        Delete a specific artifact from a repository.
 
         Args:
           extra_headers: Send extra headers

gcore/resources/cloud/registries/registries.py

@@ -105,14 +105,11 @@ class RegistriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Create a registry
+        Create a new container registry with the specified configuration.
 
         Args:
-          name: A name for the container registry.
-
-              Should be in lowercase, consisting only of numbers, letters and -,
-
-              with maximum length of 24 characters
+          name: A name for the container registry. Should be in lowercase, consisting only of
+              numbers, letters and -, with maximum length of 24 characters
 
           storage_limit: Registry storage limit, GiB
 
@@ -156,7 +153,7 @@ class RegistriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryList:
         """
-        Get registry list
+        List all container registries in the specified project and region.
 
         Args:
           extra_headers: Send extra headers
@@ -193,7 +190,7 @@ class RegistriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a registry
+        Delete a specific container registry and all its associated resources.
 
         Args:
           extra_headers: Send extra headers
@@ -231,7 +228,7 @@ class RegistriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Get a registry
+        Get detailed information about a specific container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -269,7 +266,7 @@ class RegistriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Resize a registry
+        Update the size of a container registry.
 
         Args:
           storage_limit: Registry storage limit, GiB
@@ -347,14 +344,11 @@ class AsyncRegistriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Create a registry
+        Create a new container registry with the specified configuration.
 
         Args:
-          name: A name for the container registry.
-
-              Should be in lowercase, consisting only of numbers, letters and -,
-
-              with maximum length of 24 characters
+          name: A name for the container registry. Should be in lowercase, consisting only of
+              numbers, letters and -, with maximum length of 24 characters
 
           storage_limit: Registry storage limit, GiB
 
@@ -398,7 +392,7 @@ class AsyncRegistriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryList:
         """
-        Get registry list
+        List all container registries in the specified project and region.
 
         Args:
           extra_headers: Send extra headers
@@ -435,7 +429,7 @@ class AsyncRegistriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a registry
+        Delete a specific container registry and all its associated resources.
 
         Args:
           extra_headers: Send extra headers
@@ -473,7 +467,7 @@ class AsyncRegistriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Get a registry
+        Get detailed information about a specific container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -511,7 +505,7 @@ class AsyncRegistriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
         """
-        Resize a registry
+        Update the size of a container registry.
 
         Args:
           storage_limit: Registry storage limit, GiB

gcore/resources/cloud/registries/repositories.py

@@ -53,7 +53,7 @@ class RepositoriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryRepositoryList:
         """
-        List repositories
+        List all repositories in the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -91,7 +91,7 @@ class RepositoriesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a repository
+        Delete a specific repository from the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -152,7 +152,7 @@ class AsyncRepositoriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RegistryRepositoryList:
         """
-        List repositories
+        List all repositories in the container registry.
 
         Args:
           extra_headers: Send extra headers
@@ -190,7 +190,7 @@ class AsyncRepositoriesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a repository
+        Delete a specific repository from the container registry.
 
         Args:
           extra_headers: Send extra headers

gcore/resources/cloud/registries/tags.py

@@ -55,7 +55,7 @@ class TagsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a tag
+        Delete a specific tag from an artifact.
 
         Args:
           extra_headers: Send extra headers
@@ -123,7 +123,7 @@ class AsyncTagsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete a tag
+        Delete a specific tag from an artifact.
 
         Args:
           extra_headers: Send extra headers

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,18 +62,15 @@ 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
 
-          name: A name for the registry user.
-
-              Should be in lowercase, consisting only of numbers and letters,
-
-              with maximum length of 16 characters
+          name: A name for the registry user. Should be in lowercase, consisting only of numbers
+              and letters, with maximum length of 16 characters
 
           read_only: Read-only user
 
@@ -104,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(
@@ -124,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
@@ -172,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
@@ -210,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
@@ -249,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
@@ -288,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
@@ -305,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,
         )
 
 
@@ -351,18 +348,15 @@ 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
 
-          name: A name for the registry user.
-
-              Should be in lowercase, consisting only of numbers and letters,
-
-              with maximum length of 16 characters
+          name: A name for the registry user. Should be in lowercase, consisting only of numbers
+              and letters, with maximum length of 16 characters
 
           read_only: Read-only user
 
@@ -394,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(
@@ -414,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
@@ -462,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
@@ -500,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
@@ -539,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
@@ -578,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
@@ -595,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,
         )