chore: Add a comment about config/email JSON tag bug (#2830)

Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
dexidp · Feb 16, 2023 · e2ce0b6 · e2ce0b6
1 parent 7016a82
commit e2ce0b6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/storage/storage.go b/storage/storage.go
@@ -368,6 +368,10 @@ type Connector struct {
 	ResourceVersion string `json:"resourceVersion"`
 	// Config holds all the configuration information specific to the connector type. Since there
 	// no generic struct we can use for this purpose, it is stored as a byte stream.
+	//
+	// NOTE: This is a bug. The JSON tag should be `config`.
+	// However, fixing this requires migrating Kubernetes objects for all previously created connectors,
+	// or making Dex reading both tags and act accordingly.
 	Config []byte `json:"email"`
 }