From 78ffa882be29959d2d3030464359d1878618a8aa Mon Sep 17 00:00:00 2001 From: Nilekh Chaudhari <1626598+nilekhc@users.noreply.github.com> Date: Thu, 12 Oct 2023 16:56:39 +0000 Subject: [PATCH] chore: updates api doc Signed-off-by: Nilekh Chaudhari <1626598+nilekhc@users.noreply.github.com> --- staging/src/k8s.io/kms/apis/v2/api.pb.go | 3 +++ staging/src/k8s.io/kms/apis/v2/api.proto | 3 +++ 2 files changed, 6 insertions(+) diff --git a/staging/src/k8s.io/kms/apis/v2/api.pb.go b/staging/src/k8s.io/kms/apis/v2/api.pb.go index 1b634f9323e..13715bd9c8c 100644 --- a/staging/src/k8s.io/kms/apis/v2/api.pb.go +++ b/staging/src/k8s.io/kms/apis/v2/api.pb.go @@ -289,6 +289,9 @@ type EncryptResponse struct { KeyId string `protobuf:"bytes,2,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"` // Additional metadata to be stored with the encrypted data. // This data is stored in plaintext in etcd. KMS plugin implementations are responsible for pre-encrypting any sensitive data. + // Annotations must satisfy the following constraints: + // 1. Annotation key must be a fully qualified domain name that conforms to the definition in DNS (RFC 1123). + // 2. The size of annotations keys + values is less than 32 kB. Annotations map[string][]byte `protobuf:"bytes,3,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/staging/src/k8s.io/kms/apis/v2/api.proto b/staging/src/k8s.io/kms/apis/v2/api.proto index 3c7d335e8b6..d2c90048e77 100644 --- a/staging/src/k8s.io/kms/apis/v2/api.proto +++ b/staging/src/k8s.io/kms/apis/v2/api.proto @@ -74,5 +74,8 @@ message EncryptResponse { string key_id = 2; // Additional metadata to be stored with the encrypted data. // This data is stored in plaintext in etcd. KMS plugin implementations are responsible for pre-encrypting any sensitive data. + // Annotations must satisfy the following constraints: + // 1. Annotation key must be a fully qualified domain name that conforms to the definition in DNS (RFC 1123). + // 2. The size of annotations keys + values is less than 32 kB. map annotations = 3; }