Skip to content

Commit edbf799

Browse files
Google APIscopybara-github
authored andcommitted
docs: code documentation improvements
PiperOrigin-RevId: 706891520
1 parent 42f85a6 commit edbf799

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

google/cloud/kms/v1/autokey.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ service Autokey {
5454
// Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the
5555
// provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK
5656
// use with the given resource type in the configured key project and the same
57-
// location. [GetOperation][Operations.GetOperation] should be used to resolve
58-
// the resulting long-running operation and get the resulting
59-
// [KeyHandle][google.cloud.kms.v1.KeyHandle] and
57+
// location. [GetOperation][google.longrunning.Operations.GetOperation] should
58+
// be used to resolve the resulting long-running operation and get the
59+
// resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
6060
// [CryptoKey][google.cloud.kms.v1.CryptoKey].
6161
rpc CreateKeyHandle(CreateKeyHandleRequest)
6262
returns (google.longrunning.Operation) {

google/cloud/kms/v1/ekm_service.proto

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ message Certificate {
288288
// [CryptoKeys][google.cloud.kms.v1.CryptoKey] and
289289
// [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
290290
// [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
291-
// [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as
291+
// [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], as well as
292292
// performing cryptographic operations using keys created within the
293293
// [EkmConnection][google.cloud.kms.v1.EkmConnection].
294294
message EkmConnection {
@@ -354,6 +354,7 @@ message EkmConnection {
354354
// All [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
355355
// [EkmConnection][google.cloud.kms.v1.EkmConnection] use EKM-side key
356356
// management operations initiated from Cloud KMS. This means that:
357+
//
357358
// * When a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
358359
// associated with this [EkmConnection][google.cloud.kms.v1.EkmConnection]
359360
// is
@@ -362,7 +363,8 @@ message EkmConnection {
362363
// external key material.
363364
// * Destruction of external key material associated with this
364365
// [EkmConnection][google.cloud.kms.v1.EkmConnection] can be requested by
365-
// calling [DestroyCryptoKeyVersion][EkmService.DestroyCryptoKeyVersion].
366+
// calling
367+
// [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion].
366368
// * Automatic rotation of key material is supported.
367369
CLOUD_KMS = 2;
368370
}
@@ -409,7 +411,7 @@ message EkmConnection {
409411
// [CryptoKeys][google.cloud.kms.v1.CryptoKey] and
410412
// [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
411413
// [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
412-
// [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a given
414+
// [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] in a given
413415
// project and location.
414416
message EkmConfig {
415417
option (google.api.resource) = {

google/cloud/kms/v1/resources.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ message CryptoKey {
193193
// where all related cryptographic operations are performed. Only applicable
194194
// if [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] have a
195195
// [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
196-
// [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
196+
// [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], with the
197197
// resource name in the format `projects/*/locations/*/ekmConnections/*`.
198198
// Note, this list is non-exhaustive and may apply to additional
199199
// [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel] in the future.

google/cloud/kms/v1/service.proto

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ import "google/cloud/kms/v1/resources.proto";
2424
import "google/protobuf/field_mask.proto";
2525
import "google/protobuf/wrappers.proto";
2626

27-
option cc_enable_arenas = true;
2827
option csharp_namespace = "Google.Cloud.Kms.V1";
2928
option go_package = "cloud.google.com/go/kms/apiv1/kmspb;kmspb";
3029
option java_multiple_files = true;
@@ -793,7 +792,9 @@ message ImportCryptoKeyVersionRequest {
793792
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the
794793
// [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of
795794
// [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent],
796-
// have been previously created via [ImportCryptoKeyVersion][], and be in
795+
// have been previously created via
796+
// [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion],
797+
// and be in
797798
// [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED]
798799
// or
799800
// [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED]
@@ -1504,7 +1505,8 @@ message MacVerifyRequest {
15041505
// checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService]
15051506
// will report an error if the checksum verification fails. If you receive a
15061507
// checksum error, your client should verify that
1507-
// CRC32C([MacVerifyRequest.tag][]) is equal to
1508+
// CRC32C([MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]) is
1509+
// equal to
15081510
// [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c],
15091511
// and if so, perform a limited number of retries. A persistent mismatch may
15101512
// indicate an issue in your computation of the CRC32C checksum. Note: This

0 commit comments

Comments
 (0)