Document the use of Status.result in compositor.proto

cowbon · cowbon · commit 39403e3cadcb · 2025-03-07T10:21:03.000-05:00
Clarifies that status.result = true on sucess, set to false otherwise.

Signed-off-by: Ian Chin Wang &lt;ian.chin.wang@oracle.com&gt;
diff --git a/proto/compositor.proto b/proto/compositor.proto
@@ -15,6 +15,7 @@ service Compositor {
   rpc GetEvidence(EvidenceIn) returns (EvidenceOut);
 }
 
+// Status.result = true on sucess, status.result = false on failure.
 message Status {
   bool result = 1;
   string error = 2;

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ service Compositor {`
`15`	`15`	`rpc GetEvidence(EvidenceIn) returns (EvidenceOut);`
`16`	`16`	`}`
`17`	`17`
	`18`	`+// Status.result = true on sucess, status.result = false on failure.`
`18`	`19`	`message Status {`
`19`	`20`	`bool result = 1;`
`20`	`21`	`string error = 2;`