docs(secret-manager): improve API descriptions (#95)

Author: scaleway-bot

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

@@ -129,7 +129,7 @@ async def get_secret_by_name(
         region: Optional[Region] = None,
     ) -> Secret:
         """
-        Get metadata of a Secret.
+        Get metadata of a Secret by name.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :return: :class:`Secret <Secret>`
@@ -305,7 +305,7 @@ async def delete_secret(
         region: Optional[Region] = None,
     ) -> Optional[None]:
         """
-        Delete a secret.
+        Delete 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.
 
@@ -420,7 +420,7 @@ async def get_secret_version_by_name(
         region: Optional[Region] = None,
     ) -> SecretVersion:
         """
-        Get metadata of a SecretVersion.
+        Get metadata of a SecretVersion by name.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param revision: Revision of the SecretVersion (may be a number or "latest").
@@ -507,7 +507,7 @@ async def list_secret_versions(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> ListSecretVersionsResponse:
         """
-        List versions of a secret, not returning any sensitive data.
+        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 page:
@@ -549,7 +549,7 @@ async def list_secret_versions_all(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> List[SecretVersion]:
         """
-        List versions of a secret, not returning any sensitive data.
+        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 page:
@@ -586,7 +586,7 @@ async def list_secret_versions_by_name(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> ListSecretVersionsResponse:
         """
-        List versions of a secret, not returning any sensitive data.
+        List versions of a Secret by name, not returning any sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param page:
@@ -628,7 +628,7 @@ async def list_secret_versions_by_name_all(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> List[SecretVersion]:
         """
-        List versions of a secret, not returning any sensitive data.
+        List versions of a Secret by name, not returning any sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param page:
@@ -811,7 +811,7 @@ async def access_secret_version_by_name(
         region: Optional[Region] = None,
     ) -> AccessSecretVersionResponse:
         """
-        Access a SecretVersion, returning the sensitive data.
+        Access a SecretVersion by name, returning the sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param revision: Revision of the SecretVersion (may be a number or "latest").

scaleway/scaleway/secret/v1alpha1/api.py

@@ -129,7 +129,7 @@ def get_secret_by_name(
         region: Optional[Region] = None,
     ) -> Secret:
         """
-        Get metadata of a Secret.
+        Get metadata of a Secret by name.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :return: :class:`Secret <Secret>`
@@ -305,7 +305,7 @@ def delete_secret(
         region: Optional[Region] = None,
     ) -> Optional[None]:
         """
-        Delete a secret.
+        Delete 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.
 
@@ -420,7 +420,7 @@ def get_secret_version_by_name(
         region: Optional[Region] = None,
     ) -> SecretVersion:
         """
-        Get metadata of a SecretVersion.
+        Get metadata of a SecretVersion by name.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param revision: Revision of the SecretVersion (may be a number or "latest").
@@ -507,7 +507,7 @@ def list_secret_versions(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> ListSecretVersionsResponse:
         """
-        List versions of a secret, not returning any sensitive data.
+        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 page:
@@ -549,7 +549,7 @@ def list_secret_versions_all(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> List[SecretVersion]:
         """
-        List versions of a secret, not returning any sensitive data.
+        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 page:
@@ -586,7 +586,7 @@ def list_secret_versions_by_name(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> ListSecretVersionsResponse:
         """
-        List versions of a secret, not returning any sensitive data.
+        List versions of a Secret by name, not returning any sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param page:
@@ -628,7 +628,7 @@ def list_secret_versions_by_name_all(
         status: Optional[List[SecretVersionStatus]] = None,
     ) -> List[SecretVersion]:
         """
-        List versions of a secret, not returning any sensitive data.
+        List versions of a Secret by name, not returning any sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param page:
@@ -811,7 +811,7 @@ def access_secret_version_by_name(
         region: Optional[Region] = None,
     ) -> AccessSecretVersionResponse:
         """
-        Access a SecretVersion, returning the sensitive data.
+        Access a SecretVersion by name, returning the sensitive data.
         :param region: Region to target. If none is passed will use default region from the config.
         :param secret_name: Name of the Secret.
         :param revision: Revision of the SecretVersion (may be a number or "latest").