Document ID property of CapabilityInfo (#492)

smartcontractkit · May 8, 2024 · c503b3c · c503b3c
1 parent 569a909
commit c503b3c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pkg/capabilities/capabilities.go b/pkg/capabilities/capabilities.go
@@ -168,6 +168,11 @@ type DON struct {
 
 // CapabilityInfo is a struct for the info of a capability.
 type CapabilityInfo struct {
+	// The capability ID is a fully qualified identifier for the capability.
+	//
+	// It takes the form of `{name}:{label1_key}_{labe1_value}:{label2_key}_{label2_value}@{version}`
+	//
+	// The labels within the ID are ordered alphanumerically.
 	ID             string
 	CapabilityType CapabilityType
 	Description    string