Skip to content

docs(key_manager): document key usage #1308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2024
Merged

docs(key_manager): document key usage #1308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/clients/src/api/key_manager/v1alpha1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ export interface KeyRotationPolicy {
}

export interface KeyUsage {
/** One-of ('usage'): at most one of 'symmetricEncryption' could be set. */
/**
* Algorithms used to encrypt and decrypt arbitrary payloads.
*
* One-of ('usage'): at most one of 'symmetricEncryption' could be set.
*/
symmetricEncryption?: KeyAlgorithmSymmetricEncryption
}

Expand Down Expand Up @@ -213,7 +217,7 @@ export type GenerateDataKeyRequest = {
region?: Region
/** ID of the key. */
keyId: string
/** Symmetric encryption algorithm of the data encryption key. */
/** Encryption algorithm of the data encryption key. */
algorithm?: DataKeyAlgorithmSymmetricEncryption
/**
* Default value is `false`, meaning that the plaintext is returned. Set it to
Expand Down