From 449feb359b5219726ef7367a292cb408a96a809a Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Tue, 5 Nov 2024 13:11:06 +0000 Subject: [PATCH] feat: update generated APIs --- .../scaleway_async/jobs/v1alpha1/api.py | 29 +++++++----- .../scaleway_async/jobs/v1alpha1/types.py | 46 ++++++++++++++++++- scaleway/scaleway/jobs/v1alpha1/api.py | 29 +++++++----- scaleway/scaleway/jobs/v1alpha1/types.py | 46 ++++++++++++++++++- 4 files changed, 122 insertions(+), 28 deletions(-) diff --git a/scaleway-async/scaleway_async/jobs/v1alpha1/api.py b/scaleway-async/scaleway_async/jobs/v1alpha1/api.py index cc6881368..15021b1ef 100644 --- a/scaleway-async/scaleway_async/jobs/v1alpha1/api.py +++ b/scaleway-async/scaleway_async/jobs/v1alpha1/api.py @@ -416,8 +416,9 @@ async def create_job_definition_secrets( region: Optional[Region] = None, ) -> CreateJobDefinitionSecretsResponse: """ - :param job_definition_id: UUID of the job definition to get. - :param secrets: Secrets to inject into the job. + Create a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secrets: List of secrets to inject into the job. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`CreateJobDefinitionSecretsResponse ` @@ -461,8 +462,9 @@ async def get_job_definition_secret( region: Optional[Region] = None, ) -> Secret: """ - :param job_definition_id: - :param secret_id: + Get a secret references within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`Secret ` @@ -498,7 +500,8 @@ async def list_job_definition_secrets( region: Optional[Region] = None, ) -> ListJobDefinitionSecretsResponse: """ - :param job_definition_id: + List secrets references within a job definition. + :param job_definition_id: UUID of the job definition. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`ListJobDefinitionSecretsResponse ` @@ -536,13 +539,14 @@ async def update_job_definition_secret( env_var_name: Optional[str] = None, ) -> Secret: """ - :param job_definition_id: - :param secret_id: + Update a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. - :param secret_manager_version: - :param path: + :param secret_manager_version: Version of the secret in Secret Manager. + :param path: Path of the secret to mount inside the job (either `path` or `env_var_name` must be set). One-Of ('secret_config'): at most one of 'path', 'env_var_name' could be set. - :param env_var_name: + :param env_var_name: Environment variable name used to expose the secret inside the job (either `path` or `env_var_name` must be set). One-Of ('secret_config'): at most one of 'path', 'env_var_name' could be set. :return: :class:`Secret ` @@ -590,8 +594,9 @@ async def delete_job_definition_secret( region: Optional[Region] = None, ) -> None: """ - :param job_definition_id: - :param secret_id: + Delete a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. Usage: diff --git a/scaleway-async/scaleway_async/jobs/v1alpha1/types.py b/scaleway-async/scaleway_async/jobs/v1alpha1/types.py index 2a0dbbb7d..2e5a41e56 100644 --- a/scaleway-async/scaleway_async/jobs/v1alpha1/types.py +++ b/scaleway-async/scaleway_async/jobs/v1alpha1/types.py @@ -89,10 +89,19 @@ class CreateJobDefinitionSecretsRequestSecretConfig: @dataclass class Secret: secret_id: str + """ + UUID of the secret reference within the job. + """ secret_manager_id: str + """ + UUID of the secret in Secret Manager. + """ secret_manager_version: str + """ + Version of the secret in Secret Manager. + """ file: Optional[SecretFile] @@ -254,12 +263,12 @@ class CreateJobDefinitionRequest: class CreateJobDefinitionSecretsRequest: job_definition_id: str """ - UUID of the job definition to get. + UUID of the job definition. """ secrets: List[CreateJobDefinitionSecretsRequestSecretConfig] """ - Secrets to inject into the job. + List of secrets to inject into the job. """ region: Optional[Region] @@ -271,6 +280,9 @@ class CreateJobDefinitionSecretsRequest: @dataclass class CreateJobDefinitionSecretsResponse: secrets: List[Secret] + """ + List of secrets created. + """ @dataclass @@ -289,8 +301,14 @@ class DeleteJobDefinitionRequest: @dataclass class DeleteJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -314,8 +332,14 @@ class GetJobDefinitionRequest: @dataclass class GetJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -352,6 +376,9 @@ class JobsLimits: @dataclass class ListJobDefinitionSecretsRequest: job_definition_id: str + """ + UUID of the job definition. + """ region: Optional[Region] """ @@ -362,8 +389,14 @@ class ListJobDefinitionSecretsRequest: @dataclass class ListJobDefinitionSecretsResponse: secrets: List[Secret] + """ + List of secret references within a job definition. + """ total_count: int + """ + Total count of secret references within a job definition. + """ @dataclass @@ -540,8 +573,14 @@ class UpdateJobDefinitionRequest: @dataclass class UpdateJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -549,6 +588,9 @@ class UpdateJobDefinitionSecretRequest: """ secret_manager_version: Optional[str] + """ + Version of the secret in Secret Manager. + """ path: Optional[str] diff --git a/scaleway/scaleway/jobs/v1alpha1/api.py b/scaleway/scaleway/jobs/v1alpha1/api.py index a58a55290..021a99c5a 100644 --- a/scaleway/scaleway/jobs/v1alpha1/api.py +++ b/scaleway/scaleway/jobs/v1alpha1/api.py @@ -416,8 +416,9 @@ def create_job_definition_secrets( region: Optional[Region] = None, ) -> CreateJobDefinitionSecretsResponse: """ - :param job_definition_id: UUID of the job definition to get. - :param secrets: Secrets to inject into the job. + Create a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secrets: List of secrets to inject into the job. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`CreateJobDefinitionSecretsResponse ` @@ -461,8 +462,9 @@ def get_job_definition_secret( region: Optional[Region] = None, ) -> Secret: """ - :param job_definition_id: - :param secret_id: + Get a secret references within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`Secret ` @@ -498,7 +500,8 @@ def list_job_definition_secrets( region: Optional[Region] = None, ) -> ListJobDefinitionSecretsResponse: """ - :param job_definition_id: + List secrets references within a job definition. + :param job_definition_id: UUID of the job definition. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`ListJobDefinitionSecretsResponse ` @@ -536,13 +539,14 @@ def update_job_definition_secret( env_var_name: Optional[str] = None, ) -> Secret: """ - :param job_definition_id: - :param secret_id: + Update a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. - :param secret_manager_version: - :param path: + :param secret_manager_version: Version of the secret in Secret Manager. + :param path: Path of the secret to mount inside the job (either `path` or `env_var_name` must be set). One-Of ('secret_config'): at most one of 'path', 'env_var_name' could be set. - :param env_var_name: + :param env_var_name: Environment variable name used to expose the secret inside the job (either `path` or `env_var_name` must be set). One-Of ('secret_config'): at most one of 'path', 'env_var_name' could be set. :return: :class:`Secret ` @@ -590,8 +594,9 @@ def delete_job_definition_secret( region: Optional[Region] = None, ) -> None: """ - :param job_definition_id: - :param secret_id: + Delete a secret reference within a job definition. + :param job_definition_id: UUID of the job definition. + :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. Usage: diff --git a/scaleway/scaleway/jobs/v1alpha1/types.py b/scaleway/scaleway/jobs/v1alpha1/types.py index 2a0dbbb7d..2e5a41e56 100644 --- a/scaleway/scaleway/jobs/v1alpha1/types.py +++ b/scaleway/scaleway/jobs/v1alpha1/types.py @@ -89,10 +89,19 @@ class CreateJobDefinitionSecretsRequestSecretConfig: @dataclass class Secret: secret_id: str + """ + UUID of the secret reference within the job. + """ secret_manager_id: str + """ + UUID of the secret in Secret Manager. + """ secret_manager_version: str + """ + Version of the secret in Secret Manager. + """ file: Optional[SecretFile] @@ -254,12 +263,12 @@ class CreateJobDefinitionRequest: class CreateJobDefinitionSecretsRequest: job_definition_id: str """ - UUID of the job definition to get. + UUID of the job definition. """ secrets: List[CreateJobDefinitionSecretsRequestSecretConfig] """ - Secrets to inject into the job. + List of secrets to inject into the job. """ region: Optional[Region] @@ -271,6 +280,9 @@ class CreateJobDefinitionSecretsRequest: @dataclass class CreateJobDefinitionSecretsResponse: secrets: List[Secret] + """ + List of secrets created. + """ @dataclass @@ -289,8 +301,14 @@ class DeleteJobDefinitionRequest: @dataclass class DeleteJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -314,8 +332,14 @@ class GetJobDefinitionRequest: @dataclass class GetJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -352,6 +376,9 @@ class JobsLimits: @dataclass class ListJobDefinitionSecretsRequest: job_definition_id: str + """ + UUID of the job definition. + """ region: Optional[Region] """ @@ -362,8 +389,14 @@ class ListJobDefinitionSecretsRequest: @dataclass class ListJobDefinitionSecretsResponse: secrets: List[Secret] + """ + List of secret references within a job definition. + """ total_count: int + """ + Total count of secret references within a job definition. + """ @dataclass @@ -540,8 +573,14 @@ class UpdateJobDefinitionRequest: @dataclass class UpdateJobDefinitionSecretRequest: job_definition_id: str + """ + UUID of the job definition. + """ secret_id: str + """ + UUID of the secret reference within the job. + """ region: Optional[Region] """ @@ -549,6 +588,9 @@ class UpdateJobDefinitionSecretRequest: """ secret_manager_version: Optional[str] + """ + Version of the secret in Secret Manager. + """ path: Optional[str]