feat(secret): add option to generate passwords (#124)

Author: scaleway-bot

scaleway-async/scaleway_async/secret/v1alpha1/__init__.py

@@ -6,6 +6,7 @@
 from .types import AccessSecretVersionResponse
 from .types import ListSecretVersionsResponse
 from .types import ListSecretsResponse
+from .types import PasswordGenerationParams
 from .types import Secret
 from .types import SecretVersion
 from .api import SecretV1Alpha1API
@@ -17,6 +18,7 @@
     "AccessSecretVersionResponse",
     "ListSecretVersionsResponse",
     "ListSecretsResponse",
+    "PasswordGenerationParams",
     "Secret",
     "SecretVersion",
     "SecretV1Alpha1API",

scaleway-async/scaleway_async/secret/v1alpha1/api.py

@@ -17,6 +17,7 @@
     AccessSecretVersionResponse,
     ListSecretVersionsResponse,
     ListSecretsResponse,
+    PasswordGenerationParams,
     Secret,
     SecretVersion,
     CreateSecretRequest,
@@ -343,6 +344,7 @@ async def create_secret_version(
         disable_previous: bool,
         region: Optional[Region] = None,
         description: Optional[str] = None,
+        password_generation: Optional[PasswordGenerationParams] = None,
     ) -> SecretVersion:
         """
         Create a version.
@@ -353,6 +355,12 @@ async def create_secret_version(
         :param description: Description of the version.
         :param disable_previous: Disable the previous secret version.
         If there is no previous version or if the previous version was already disabled, does nothing.
+        :param password_generation: Options to generate a password.
+        If specified, a random password will be generated. The data field must be empty.
+        By default, the generator will use upper and lower case letters, and digits.
+        This behavior can be tuned using the generation params.
+
+        One-of ('_password_generation'): at most one of 'password_generation' could be set.
         :return: :class:`SecretVersion <SecretVersion>`
 
         Usage:
@@ -380,6 +388,7 @@ async def create_secret_version(
                     disable_previous=disable_previous,
                     region=region,
                     description=description,
+                    password_generation=password_generation,
                 ),
                 self.client,
             ),

scaleway-async/scaleway_async/secret/v1alpha1/marshalling.py

@@ -4,11 +4,16 @@
 from typing import Any, Dict
 
 from scaleway_core.profile import ProfileDefaults
+from scaleway_core.utils import (
+    OneOfPossibility,
+    resolve_one_of,
+)
 from dateutil import parser
 from .types import (
     AccessSecretVersionResponse,
     ListSecretVersionsResponse,
     ListSecretsResponse,
+    PasswordGenerationParams,
     Secret,
     SecretVersion,
     CreateSecretRequest,
@@ -142,6 +147,19 @@ def unmarshal_ListSecretsResponse(data: Any) -> ListSecretsResponse:
     return ListSecretsResponse(**args)
 
 
+def marshal_PasswordGenerationParams(
+    request: PasswordGenerationParams,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    return {
+        "additional_chars": request.additional_chars,
+        "length": request.length,
+        "no_digits": request.no_digits,
+        "no_lowercase_letters": request.no_lowercase_letters,
+        "no_uppercase_letters": request.no_uppercase_letters,
+    }
+
+
 def marshal_CreateSecretRequest(
     request: CreateSecretRequest,
     defaults: ProfileDefaults,
@@ -159,6 +177,18 @@ def marshal_CreateSecretVersionRequest(
     defaults: ProfileDefaults,
 ) -> Dict[str, Any]:
     return {
+        **resolve_one_of(
+            [
+                OneOfPossibility(
+                    "password_generation",
+                    marshal_PasswordGenerationParams(
+                        request.password_generation, defaults
+                    )
+                    if request.password_generation is not None
+                    else None,
+                ),
+            ]
+        ),
         "data": request.data,
         "description": request.description,
         "disable_previous": request.disable_previous,

scaleway-async/scaleway_async/secret/v1alpha1/types.py

@@ -98,6 +98,38 @@ class ListSecretsResponse:
     """
 
 
+@dataclass
+class PasswordGenerationParams:
+    """
+    Password generation params.
+    """
+
+    length: int
+    """
+    Length of the password to generate (between 1 and 1024).
+    """
+
+    no_lowercase_letters: bool
+    """
+    Do not include lower case letters by default in the alphabet.
+    """
+
+    no_uppercase_letters: bool
+    """
+    Do not include upper case letters by default in the alphabet.
+    """
+
+    no_digits: bool
+    """
+    Do not include digits by default in the alphabet.
+    """
+
+    additional_chars: str
+    """
+    Additional ascii characters to be included in the alphabet.
+    """
+
+
 @dataclass
 class Secret:
     """
@@ -355,6 +387,16 @@ class CreateSecretVersionRequest:
     If there is no previous version or if the previous version was already disabled, does nothing.
     """
 
+    password_generation: Optional[PasswordGenerationParams]
+    """
+    Options to generate a password.
+    If specified, a random password will be generated. The data field must be empty.
+    By default, the generator will use upper and lower case letters, and digits.
+    This behavior can be tuned using the generation params.
+    
+    One-of ('_password_generation'): at most one of 'password_generation' could be set.
+    """
+
 
 @dataclass
 class GetSecretVersionRequest:

scaleway/scaleway/secret/v1alpha1/__init__.py

@@ -6,6 +6,7 @@
 from .types import AccessSecretVersionResponse
 from .types import ListSecretVersionsResponse
 from .types import ListSecretsResponse
+from .types import PasswordGenerationParams
 from .types import Secret
 from .types import SecretVersion
 from .api import SecretV1Alpha1API
@@ -17,6 +18,7 @@
     "AccessSecretVersionResponse",
     "ListSecretVersionsResponse",
     "ListSecretsResponse",
+    "PasswordGenerationParams",
     "Secret",
     "SecretVersion",
     "SecretV1Alpha1API",

scaleway/scaleway/secret/v1alpha1/api.py

@@ -17,6 +17,7 @@
     AccessSecretVersionResponse,
     ListSecretVersionsResponse,
     ListSecretsResponse,
+    PasswordGenerationParams,
     Secret,
     SecretVersion,
     CreateSecretRequest,
@@ -343,6 +344,7 @@ def create_secret_version(
         disable_previous: bool,
         region: Optional[Region] = None,
         description: Optional[str] = None,
+        password_generation: Optional[PasswordGenerationParams] = None,
     ) -> SecretVersion:
         """
         Create a version.
@@ -353,6 +355,12 @@ def create_secret_version(
         :param description: Description of the version.
         :param disable_previous: Disable the previous secret version.
         If there is no previous version or if the previous version was already disabled, does nothing.
+        :param password_generation: Options to generate a password.
+        If specified, a random password will be generated. The data field must be empty.
+        By default, the generator will use upper and lower case letters, and digits.
+        This behavior can be tuned using the generation params.
+
+        One-of ('_password_generation'): at most one of 'password_generation' could be set.
         :return: :class:`SecretVersion <SecretVersion>`
 
         Usage:
@@ -380,6 +388,7 @@ def create_secret_version(
                     disable_previous=disable_previous,
                     region=region,
                     description=description,
+                    password_generation=password_generation,
                 ),
                 self.client,
             ),

scaleway/scaleway/secret/v1alpha1/marshalling.py

@@ -4,11 +4,16 @@
 from typing import Any, Dict
 
 from scaleway_core.profile import ProfileDefaults
+from scaleway_core.utils import (
+    OneOfPossibility,
+    resolve_one_of,
+)
 from dateutil import parser
 from .types import (
     AccessSecretVersionResponse,
     ListSecretVersionsResponse,
     ListSecretsResponse,
+    PasswordGenerationParams,
     Secret,
     SecretVersion,
     CreateSecretRequest,
@@ -142,6 +147,19 @@ def unmarshal_ListSecretsResponse(data: Any) -> ListSecretsResponse:
     return ListSecretsResponse(**args)
 
 
+def marshal_PasswordGenerationParams(
+    request: PasswordGenerationParams,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    return {
+        "additional_chars": request.additional_chars,
+        "length": request.length,
+        "no_digits": request.no_digits,
+        "no_lowercase_letters": request.no_lowercase_letters,
+        "no_uppercase_letters": request.no_uppercase_letters,
+    }
+
+
 def marshal_CreateSecretRequest(
     request: CreateSecretRequest,
     defaults: ProfileDefaults,
@@ -159,6 +177,18 @@ def marshal_CreateSecretVersionRequest(
     defaults: ProfileDefaults,
 ) -> Dict[str, Any]:
     return {
+        **resolve_one_of(
+            [
+                OneOfPossibility(
+                    "password_generation",
+                    marshal_PasswordGenerationParams(
+                        request.password_generation, defaults
+                    )
+                    if request.password_generation is not None
+                    else None,
+                ),
+            ]
+        ),
         "data": request.data,
         "description": request.description,
         "disable_previous": request.disable_previous,

scaleway/scaleway/secret/v1alpha1/types.py

@@ -98,6 +98,38 @@ class ListSecretsResponse:
     """
 
 
+@dataclass
+class PasswordGenerationParams:
+    """
+    Password generation params.
+    """
+
+    length: int
+    """
+    Length of the password to generate (between 1 and 1024).
+    """
+
+    no_lowercase_letters: bool
+    """
+    Do not include lower case letters by default in the alphabet.
+    """
+
+    no_uppercase_letters: bool
+    """
+    Do not include upper case letters by default in the alphabet.
+    """
+
+    no_digits: bool
+    """
+    Do not include digits by default in the alphabet.
+    """
+
+    additional_chars: str
+    """
+    Additional ascii characters to be included in the alphabet.
+    """
+
+
 @dataclass
 class Secret:
     """
@@ -355,6 +387,16 @@ class CreateSecretVersionRequest:
     If there is no previous version or if the previous version was already disabled, does nothing.
     """
 
+    password_generation: Optional[PasswordGenerationParams]
+    """
+    Options to generate a password.
+    If specified, a random password will be generated. The data field must be empty.
+    By default, the generator will use upper and lower case letters, and digits.
+    This behavior can be tuned using the generation params.
+    
+    One-of ('_password_generation'): at most one of 'password_generation' could be set.
+    """
+
 
 @dataclass
 class GetSecretVersionRequest: