Skip to content

Commit 918cb7b

Browse files
authored
docs(key_manager): document key usage (#1308)
1 parent 566a38e commit 918cb7b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

packages/clients/src/api/key_manager/v1alpha1/types.gen.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@ export interface KeyRotationPolicy {
3535
}
3636

3737
export interface KeyUsage {
38-
/** One-of ('usage'): at most one of 'symmetricEncryption' could be set. */
38+
/**
39+
* Algorithms used to encrypt and decrypt arbitrary payloads.
40+
*
41+
* One-of ('usage'): at most one of 'symmetricEncryption' could be set.
42+
*/
3943
symmetricEncryption?: KeyAlgorithmSymmetricEncryption
4044
}
4145

@@ -213,7 +217,7 @@ export type GenerateDataKeyRequest = {
213217
region?: Region
214218
/** ID of the key. */
215219
keyId: string
216-
/** Symmetric encryption algorithm of the data encryption key. */
220+
/** Encryption algorithm of the data encryption key. */
217221
algorithm?: DataKeyAlgorithmSymmetricEncryption
218222
/**
219223
* Default value is `false`, meaning that the plaintext is returned. Set it to

0 commit comments

Comments
 (0)