chore: improve references docs

crossplane · Jun 1, 2024 · ed43b19 · ed43b19
1 parent 4073347
commit ed43b19
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pkg/config/resource.go b/pkg/config/resource.go
@@ -167,6 +167,9 @@ type ExternalName struct {
 
 // References represents reference resolver configurations for the fields of a
 // given resource. Key should be the field path of the field to be referenced.
+// The key is the Terraform field path of the field to be referenced.
+// Example: "vpc_id" or "forwarding_rule.certificate_name" in case of nested
+// in another object.
 type References map[string]Reference
 
 // Reference represents the Crossplane options used to generate