Merge pull request #195 from wes-johnson/develop

wes-johnson · web-flow · commit 44648c9ae78a · 2022-05-16T11:14:09.000-07:00
Fixes eclipse-sparkplug/sparkplug#126 by improving the comment in the protobuf definition file for template_ref
diff --git a/sparkplug_b/sparkplug_b.proto b/sparkplug_b/sparkplug_b.proto
@@ -97,7 +97,7 @@ message Payload {
         optional string version         = 1;          // The version of the Template to prevent mismatches
         repeated Metric metrics         = 2;          // Each metric includes a name, datatype, and optionally a value
         repeated Parameter parameters   = 3;
-        optional string template_ref    = 4;          // Reference to a template if this is extending a Template or an instance - must exist if an instance
+        optional string template_ref    = 4;          // MUST be a reference to a template definition if this is an instance (i.e. the name of the template definition) - MUST be omitted for template definitions
         optional bool is_definition     = 5;
         extensions                      6 to max;
     }

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ message Payload {`
`97`	`97`	`optional string version = 1; // The version of the Template to prevent mismatches`
`98`	`98`	`repeated Metric metrics = 2; // Each metric includes a name, datatype, and optionally a value`
`99`	`99`	`repeated Parameter parameters = 3;`
`100`		`- optional string template_ref = 4; // Reference to a template if this is extending a Template or an instance - must exist if an instance`
	`100`	`+ optional string template_ref = 4; // MUST be a reference to a template definition if this is an instance (i.e. the name of the template definition) - MUST be omitted for template definitions`
`101`	`101`	`optional bool is_definition = 5;`
`102`	`102`	`extensions 6 to max;`
`103`	`103`	`}`