Skip to content

Commit e21993b

Browse files
authored
docs(key_manager): update documentation (#608)
1 parent 1a2fb70 commit e21993b

File tree

4 files changed

+6
-12
lines changed

4 files changed

+6
-12
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ async def generate_data_key(
515515
:param without_plaintext: Default value is `false`, meaning that the plaintext is returned.
516516
Set it to `true` if you do not wish the plaintext to be returned in the response object.
517517
:param region: Region to target. If none is passed will use default region from the config.
518-
:param algorithm: Encryption algorithm of the data encryption key.
518+
:param algorithm: See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values.
519519
:return: :class:`DataKey <DataKey>`
520520
521521
Usage:

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,7 @@ class Key:
9090

9191
state: KeyState
9292
"""
93-
Current state of the key. Values include:
94-
* `unknown_state`: key is in an unknown state.
95-
* `enabled`: key can be used for cryptographic operations.
96-
* `disabled`: key cannot be used for cryptographic operations.
93+
See the `Key.State` enum for a description of values.
9794
"""
9895

9996
rotation_count: int
@@ -359,7 +356,7 @@ class GenerateDataKeyRequest:
359356

360357
algorithm: Optional[DataKeyAlgorithmSymmetricEncryption]
361358
"""
362-
Encryption algorithm of the data encryption key.
359+
See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values.
363360
"""
364361

365362

scaleway/scaleway/key_manager/v1alpha1/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ def generate_data_key(
515515
:param without_plaintext: Default value is `false`, meaning that the plaintext is returned.
516516
Set it to `true` if you do not wish the plaintext to be returned in the response object.
517517
:param region: Region to target. If none is passed will use default region from the config.
518-
:param algorithm: Encryption algorithm of the data encryption key.
518+
:param algorithm: See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values.
519519
:return: :class:`DataKey <DataKey>`
520520
521521
Usage:

scaleway/scaleway/key_manager/v1alpha1/types.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,7 @@ class Key:
9090

9191
state: KeyState
9292
"""
93-
Current state of the key. Values include:
94-
* `unknown_state`: key is in an unknown state.
95-
* `enabled`: key can be used for cryptographic operations.
96-
* `disabled`: key cannot be used for cryptographic operations.
93+
See the `Key.State` enum for a description of values.
9794
"""
9895

9996
rotation_count: int
@@ -359,7 +356,7 @@ class GenerateDataKeyRequest:
359356

360357
algorithm: Optional[DataKeyAlgorithmSymmetricEncryption]
361358
"""
362-
Encryption algorithm of the data encryption key.
359+
See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values.
363360
"""
364361

365362

0 commit comments

Comments
 (0)