Clarify log index in transparency log entry vs inclusion proof (#101)

* clarify log index in tle vs inclusion proof Signed-off-by: Ceridwen Coghlan <[email protected]> * ran make all Signed-off-by: Ceridwen Coghlan <[email protected]> * comment suggestion Co-authored-by: Hayden B <[email protected]> Signed-off-by: Ceridwen Coghlan <[email protected]> * ran make all again Signed-off-by: Ceridwen Coghlan <[email protected]> --------- Signed-off-by: Ceridwen Coghlan <[email protected]> Co-authored-by: Hayden B <[email protected]>
sigstore · Jul 26, 2023 · 265fd3a · 265fd3a
1 parent 5b10d0f
commit 265fd3a
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/gen/pb-go/rekor/v1/sigstore_rekor.pb.go b/gen/pb-go/rekor/v1/sigstore_rekor.pb.go
diff --git a/gen/pb-python/sigstore_protobuf_specs/dev/sigstore/rekor/v1/__init__.py b/gen/pb-python/sigstore_protobuf_specs/dev/sigstore/rekor/v1/__init__.py
diff --git a/gen/pb-typescript/src/__generated__/sigstore_rekor.ts b/gen/pb-typescript/src/__generated__/sigstore_rekor.ts
diff --git a/protos/sigstore_rekor.proto b/protos/sigstore_rekor.proto
@@ -49,7 +49,7 @@ message Checkpoint {
 // InclusionProof is the proof returned from the transparency log. Can
 // be used for offline or online verification against the log.
 message InclusionProof {
-        // The index of the entry in the log.
+        // The index of the entry in the tree it was written to.
         int64 log_index = 1 [(google.api.field_behavior) = REQUIRED];
         // The hash digest stored at the root of the merkle tree at the time
         // the proof was generated.
@@ -90,7 +90,7 @@ message InclusionPromise {
 // the response from Rekor) is similar to a Signed Certificate Timestamp
 // as described here https://www.rfc-editor.org/rfc/rfc6962.html#section-3.2.
 message TransparencyLogEntry {
-        // The index of the entry in the log.
+        // The global index of the entry, used when querying the log by index.
         int64 log_index = 1 [(google.api.field_behavior) = REQUIRED];
         // The unique identifier of the log.
         dev.sigstore.common.v1.LogId log_id = 2 [(google.api.field_behavior) = REQUIRED];