Browse Source

chore: clarify optional/required fields in API types

Signed-off-by: Jordan Sauvain <jordan.sauvain@ovhcloud.com>
Jordan Sauvain 4 tháng trước cách đây
mục cha
commit
5fce249879

+ 0 - 4
apis/externalsecrets/v1/secretstore_ovh_types.go

@@ -19,7 +19,6 @@ package v1
 import esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
 
 // OvhProvider holds the configuration to synchronize secrets with OVHcloud's Secret Manager.
-// +optional
 type OvhProvider struct {
 	// specifies the OKMS server endpoint.
 	// +required
@@ -40,7 +39,6 @@ type OvhProvider struct {
 }
 
 // OvhAuth tells the controller how to authenticate to OVHcloud's Secret Manager, either using mTLS or a token.
-// +required
 type OvhAuth struct {
 	// +optional
 	ClientMTLS *OvhClientMTLS `json:"mtls,omitempty"`
@@ -49,7 +47,6 @@ type OvhAuth struct {
 }
 
 // OvhClientMTLS defines the configuration required to authenticate to OVHcloud's Secret Manager using mTLS.
-// +optional
 type OvhClientMTLS struct {
 	// +required
 	ClientCertificate *esmeta.SecretKeySelector `json:"certSecretRef,omitempty"`
@@ -58,7 +55,6 @@ type OvhClientMTLS struct {
 }
 
 // OvhClientToken defines the configuration required to authenticate to OVHcloud's Secret Manager using a token.
-// +optional
 type OvhClientToken struct {
 	// +required
 	ClientTokenSecret *esmeta.SecretKeySelector `json:"tokenSecretRef,omitempty"`

+ 2 - 0
apis/externalsecrets/v1/secretstore_types.go

@@ -87,6 +87,8 @@ type SecretStoreProvider struct {
 	// +optional
 	Vault *VaultProvider `json:"vault,omitempty"`
 
+	// Ovh configures this store to sync secrets using the OVHcloud provider.
+	// +optional
 	Ovh *OvhProvider `json:"ovh,omitempty"`
 
 	// GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider