feat(secret-manager): add endpoints for using name to retrieve secrets (#46)

Author: scaleway-bot

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

@@ -8,7 +8,9 @@
     Region,
 )
 from scaleway_core.utils import (
+    OneOfPossibility,
     fetch_all_pages_async,
+    resolve_one_of,
     validate_path_param,
 )
 from .types import (
@@ -93,19 +95,23 @@ async def create_secret(
     async def get_secret(
         self,
         *,
-        secret_id: str,
         region: Optional[Region] = None,
+        secret_id: Optional[str] = None,
+        secret_name: Optional[str] = None,
     ) -> Secret:
         """
         Get metadata of a Secret
         :param region: Region to target. If none is passed will use default region from the config
         :param secret_id: ID of the Secret
+        :param secret_name: Name of the Secret (alternative to secret_id).
+
+        One-of ('secret_ref'): at most one of 'secret_name' could be set.
         :return: :class:`Secret <Secret>`
 
         Usage:
         ::
 
-            result = await api.get_secret(secret_id="example")
+            result = await api.get_secret()
         """
 
         param_region = validate_path_param(
@@ -116,6 +122,13 @@ async def get_secret(
         res = self._request(
             "GET",
             f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}",
+            params={
+                **resolve_one_of(
+                    [
+                        OneOfPossibility("secret_name", secret_name),
+                    ]
+                ),
+            },
         )
 
         self._throw_on_error(res)
@@ -175,6 +188,7 @@ async def list_secrets(
         organization_id: Optional[str] = None,
         project_id: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        name: Optional[str] = None,
         order_by: ListSecretsRequestOrderBy = ListSecretsRequestOrderBy.NAME_ASC,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
@@ -185,6 +199,7 @@ async def list_secrets(
         :param organization_id: ID of an organization to filter on (optional)
         :param project_id: ID of a project to filter on (optional)
         :param tags: List of tags to filter on (optional)
+        :param name: Name of the secrets (optional)
         :param order_by:
         :param page:
         :param page_size:
@@ -204,6 +219,7 @@ async def list_secrets(
             "GET",
             f"/secret-manager/v1alpha1/regions/{param_region}/secrets",
             params={
+                "name": name,
                 "order_by": order_by,
                 "organization_id": organization_id
                 or self.client.default_organization_id,
@@ -224,6 +240,7 @@ async def list_secrets_all(
         organization_id: Optional[str] = None,
         project_id: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        name: Optional[str] = None,
         order_by: Optional[ListSecretsRequestOrderBy] = None,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
@@ -234,6 +251,7 @@ async def list_secrets_all(
         :param organization_id: ID of an organization to filter on (optional)
         :param project_id: ID of a project to filter on (optional)
         :param tags: List of tags to filter on (optional)
+        :param name: Name of the secrets (optional)
         :param order_by:
         :param page:
         :param page_size:
@@ -254,6 +272,7 @@ async def list_secrets_all(
                 "organization_id": organization_id,
                 "project_id": project_id,
                 "tags": tags,
+                "name": name,
                 "order_by": order_by,
                 "page": page,
                 "page_size": page_size,
@@ -340,24 +359,25 @@ async def create_secret_version(
     async def get_secret_version(
         self,
         *,
-        secret_id: str,
         revision: str,
         region: Optional[Region] = None,
+        secret_id: Optional[str] = None,
+        secret_name: Optional[str] = None,
     ) -> SecretVersion:
         """
         Get metadata of a SecretVersion
         :param region: Region to target. If none is passed will use default region from the config
         :param secret_id: ID of the Secret
         :param revision: Revision of the SecretVersion (may be a number or "latest")
+        :param secret_name: Name of the Secret (alternative to secret_id).
+
+        One-of ('secret_ref'): at most one of 'secret_name' could be set.
         :return: :class:`SecretVersion <SecretVersion>`
 
         Usage:
         ::
 
-            result = await api.get_secret_version(
-                secret_id="example",
-                revision="example",
-            )
+            result = await api.get_secret_version(revision="example")
         """
 
         param_region = validate_path_param(
@@ -369,6 +389,13 @@ async def get_secret_version(
         res = self._request(
             "GET",
             f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}/versions/{param_revision}",
+            params={
+                **resolve_one_of(
+                    [
+                        OneOfPossibility("secret_name", secret_name),
+                    ]
+                ),
+            },
         )
 
         self._throw_on_error(res)
@@ -425,8 +452,9 @@ async def update_secret_version(
     async def list_secret_versions(
         self,
         *,
-        secret_id: str,
         region: Optional[Region] = None,
+        secret_id: Optional[str] = None,
+        secret_name: Optional[str] = None,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         status: Optional[List[SecretVersionStatus]] = None,
@@ -435,6 +463,9 @@ async def list_secret_versions(
         List versions of a secret, not returning any sensitive data
         :param region: Region to target. If none is passed will use default region from the config
         :param secret_id: ID of the Secret
+        :param secret_name: Name of the Secret (alternative to secret_id).
+
+        One-of ('secret_ref'): at most one of 'secret_name' could be set.
         :param page:
         :param page_size:
         :param status: Filter results by status
@@ -443,7 +474,7 @@ async def list_secret_versions(
         Usage:
         ::
 
-            result = await api.list_secret_versions(secret_id="example")
+            result = await api.list_secret_versions()
         """
 
         param_region = validate_path_param(
@@ -458,6 +489,11 @@ async def list_secret_versions(
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
                 "status": status,
+                **resolve_one_of(
+                    [
+                        OneOfPossibility("secret_name", secret_name),
+                    ]
+                ),
             },
         )
 
@@ -467,8 +503,9 @@ async def list_secret_versions(
     async def list_secret_versions_all(
         self,
         *,
-        secret_id: str,
         region: Optional[Region] = None,
+        secret_id: Optional[str] = None,
+        secret_name: Optional[str] = None,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         status: Optional[List[SecretVersionStatus]] = None,
@@ -477,6 +514,9 @@ async def list_secret_versions_all(
         List versions of a secret, not returning any sensitive data
         :param region: Region to target. If none is passed will use default region from the config
         :param secret_id: ID of the Secret
+        :param secret_name: Name of the Secret (alternative to secret_id).
+
+        One-of ('secret_ref'): at most one of 'secret_name' could be set.
         :param page:
         :param page_size:
         :param status: Filter results by status
@@ -485,16 +525,17 @@ async def list_secret_versions_all(
         Usage:
         ::
 
-            result = await api.list_secret_versions_all(secret_id="example")
+            result = await api.list_secret_versions_all()
         """
 
         return await fetch_all_pages_async(
             type=ListSecretVersionsResponse,
             key="versions",
             fetcher=self.list_secret_versions,
             args={
-                "secret_id": secret_id,
                 "region": region,
+                "secret_id": secret_id,
+                "secret_name": secret_name,
                 "page": page,
                 "page_size": page_size,
                 "status": status,
@@ -615,24 +656,25 @@ async def disable_secret_version(
     async def access_secret_version(
         self,
         *,
-        secret_id: str,
         revision: str,
         region: Optional[Region] = None,
+        secret_id: Optional[str] = None,
+        secret_name: Optional[str] = None,
     ) -> AccessSecretVersionResponse:
         """
         Access a SecretVersion, returning the sensitive data
         :param region: Region to target. If none is passed will use default region from the config
         :param secret_id: ID of the Secret
-        :param revision: Revision of the SecretVersion (may be a number or "latest")
+        :param revision: Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")
+        :param secret_name: Name of the Secret (alternative to secret_id).
+
+        One-of ('secret_ref'): at most one of 'secret_name' could be set.
         :return: :class:`AccessSecretVersionResponse <AccessSecretVersionResponse>`
 
         Usage:
         ::
 
-            result = await api.access_secret_version(
-                secret_id="example",
-                revision="example",
-            )
+            result = await api.access_secret_version(revision="example")
         """
 
         param_region = validate_path_param(
@@ -644,6 +686,13 @@ async def access_secret_version(
         res = self._request(
             "GET",
             f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}/versions/{param_revision}/access",
+            params={
+                **resolve_one_of(
+                    [
+                        OneOfPossibility("secret_name", secret_name),
+                    ]
+                ),
+            },
         )
 
         self._throw_on_error(res)

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

@@ -233,11 +233,18 @@ class GetSecretRequest:
     Region to target. If none is passed will use default region from the config
     """
 
-    secret_id: str
+    secret_id: Optional[str]
     """
     ID of the Secret
     """
 
+    secret_name: Optional[str]
+    """
+    Name of the Secret (alternative to secret_id).
+    
+    One-of ('secret_ref'): at most one of 'secret_name' could be set.
+    """
+
 
 @dataclass
 class UpdateSecretRequest:
@@ -289,6 +296,11 @@ class ListSecretsRequest:
     List of tags to filter on (optional)
     """
 
+    name: Optional[str]
+    """
+    Name of the secrets (optional)
+    """
+
     order_by: Optional[ListSecretsRequestOrderBy]
 
     page: Optional[int]
@@ -339,7 +351,7 @@ class GetSecretVersionRequest:
     Region to target. If none is passed will use default region from the config
     """
 
-    secret_id: str
+    secret_id: Optional[str]
     """
     ID of the Secret
     """
@@ -349,6 +361,13 @@ class GetSecretVersionRequest:
     Revision of the SecretVersion (may be a number or "latest")
     """
 
+    secret_name: Optional[str]
+    """
+    Name of the Secret (alternative to secret_id).
+    
+    One-of ('secret_ref'): at most one of 'secret_name' could be set.
+    """
+
 
 @dataclass
 class UpdateSecretVersionRequest:
@@ -380,11 +399,18 @@ class ListSecretVersionsRequest:
     Region to target. If none is passed will use default region from the config
     """
 
-    secret_id: str
+    secret_id: Optional[str]
     """
     ID of the Secret
     """
 
+    secret_name: Optional[str]
+    """
+    Name of the Secret (alternative to secret_id).
+    
+    One-of ('secret_ref'): at most one of 'secret_name' could be set.
+    """
+
     page: Optional[int]
 
     page_size: Optional[int]
@@ -456,12 +482,19 @@ class AccessSecretVersionRequest:
     Region to target. If none is passed will use default region from the config
     """
 
-    secret_id: str
+    secret_id: Optional[str]
     """
     ID of the Secret
     """
 
     revision: str
     """
-    Revision of the SecretVersion (may be a number or "latest")
+    Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")
+    """
+
+    secret_name: Optional[str]
+    """
+    Name of the Secret (alternative to secret_id).
+    
+    One-of ('secret_ref'): at most one of 'secret_name' could be set.
     """