[create-pull-request] automated change (#41)

Co-authored-by: authzedbot <86801627+authzedbot@users.noreply.github.com>

Author: github-actions[bot]

buf.gen.yaml

@@ -12,4 +12,4 @@ plugins:
       - "base_namespace="
       - "no_server=on"
 inputs:
-  - module: buf.build/authzed/api:v1.45.0
+  - module: buf.build/authzed/api:v1.45.4

src/Authzed.Net/Authzed/Api/V1/Core.cs

@@ -1249,8 +1249,9 @@ public void MergeFrom(pb::CodedInputStream input) {
   }
 
   /// <summary>
-  /// ZedToken is used to provide causality metadata between Write and Check
-  /// requests.
+  /// ZedToken represents a point in time, or a "revision" in SpiceDB.
+  /// It is used to provide causality metadata between Write and read requests (Check, ReadRelationships, LookupResources, LookupSubjects)
+  /// and can also be used to start watching for changes from a specific point in time.
   ///
   /// See the authzed.api.v1.Consistency message for more information.
   /// </summary>

src/Authzed.Net/Authzed/Api/V1/PermissionService.cs

@@ -2916,6 +2916,9 @@ public WriteRelationshipsResponse Clone() {
     /// <summary>Field number for the "written_at" field.</summary>
     public const int WrittenAtFieldNumber = 1;
     private global::Authzed.Api.V1.ZedToken writtenAt_;
+    /// <summary>
+    /// written_at is the revision at which the relationships were written or deleted.
+    /// </summary>
     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
     public global::Authzed.Api.V1.ZedToken WrittenAt {

src/Authzed.Net/Authzed/Api/V1/WatchService.cs

@@ -41,27 +41,29 @@ static WatchServiceReflection() {
             "MiIuYXV0aHplZC5hcGkudjEuUmVsYXRpb25zaGlwRmlsdGVyUhtvcHRpb25h",
             "bFJlbGF0aW9uc2hpcEZpbHRlcnMSTQoVb3B0aW9uYWxfdXBkYXRlX2tpbmRz",
             "GAQgAygOMhkuYXV0aHplZC5hcGkudjEuV2F0Y2hLaW5kUhNvcHRpb25hbFVw",
-            "ZGF0ZUtpbmRzIrkCCg1XYXRjaFJlc3BvbnNlEjwKB3VwZGF0ZXMYASADKAsy",
+            "ZGF0ZUtpbmRzIogDCg1XYXRjaFJlc3BvbnNlEjwKB3VwZGF0ZXMYASADKAsy",
             "Ii5hdXRoemVkLmFwaS52MS5SZWxhdGlvbnNoaXBVcGRhdGVSB3VwZGF0ZXMS",
             "QQoPY2hhbmdlc190aHJvdWdoGAIgASgLMhguYXV0aHplZC5hcGkudjEuWmVk",
             "VG9rZW5SDmNoYW5nZXNUaHJvdWdoElsKHW9wdGlvbmFsX3RyYW5zYWN0aW9u",
             "X21ldGFkYXRhGAMgASgLMhcuZ29vZ2xlLnByb3RvYnVmLlN0cnVjdFIbb3B0",
             "aW9uYWxUcmFuc2FjdGlvbk1ldGFkYXRhEiUKDnNjaGVtYV91cGRhdGVkGAQg",
             "ASgIUg1zY2hlbWFVcGRhdGVkEiMKDWlzX2NoZWNrcG9pbnQYBSABKAhSDGlz",
-            "Q2hlY2twb2ludCqfAQoJV2F0Y2hLaW5kEhoKFldBVENIX0tJTkRfVU5TUEVD",
-            "SUZJRUQQABIrCidXQVRDSF9LSU5EX0lOQ0xVREVfUkVMQVRJT05TSElQX1VQ",
-            "REFURVMQARIlCiFXQVRDSF9LSU5EX0lOQ0xVREVfU0NIRU1BX1VQREFURVMQ",
-            "AhIiCh5XQVRDSF9LSU5EX0lOQ0xVREVfQ0hFQ0tQT0lOVFMQAzJ2CgxXYXRj",
-            "aFNlcnZpY2USZgoFV2F0Y2gSHC5hdXRoemVkLmFwaS52MS5XYXRjaFJlcXVl",
-            "c3QaHS5hdXRoemVkLmFwaS52MS5XYXRjaFJlc3BvbnNlIh6SQQcKBVdhdGNo",
-            "gtPkkwIOIgkvdjEvd2F0Y2g6ASowAUJKChJjb20uYXV0aHplZC5hcGkudjFQ",
-            "AVoyZ2l0aHViLmNvbS9hdXRoemVkL2F1dGh6ZWQtZ28vcHJvdG8vYXV0aHpl",
-            "ZC9hcGkvdjFiBnByb3RvMw=="));
+            "Q2hlY2twb2ludBJNChZmdWxsX3JldmlzaW9uX21ldGFkYXRhGAYgAygLMhcu",
+            "Z29vZ2xlLnByb3RvYnVmLlN0cnVjdFIUZnVsbFJldmlzaW9uTWV0YWRhdGEq",
+            "nwEKCVdhdGNoS2luZBIaChZXQVRDSF9LSU5EX1VOU1BFQ0lGSUVEEAASKwon",
+            "V0FUQ0hfS0lORF9JTkNMVURFX1JFTEFUSU9OU0hJUF9VUERBVEVTEAESJQoh",
+            "V0FUQ0hfS0lORF9JTkNMVURFX1NDSEVNQV9VUERBVEVTEAISIgoeV0FUQ0hf",
+            "S0lORF9JTkNMVURFX0NIRUNLUE9JTlRTEAMydgoMV2F0Y2hTZXJ2aWNlEmYK",
+            "BVdhdGNoEhwuYXV0aHplZC5hcGkudjEuV2F0Y2hSZXF1ZXN0Gh0uYXV0aHpl",
+            "ZC5hcGkudjEuV2F0Y2hSZXNwb25zZSIekkEHCgVXYXRjaILT5JMCDiIJL3Yx",
+            "L3dhdGNoOgEqMAFCSgoSY29tLmF1dGh6ZWQuYXBpLnYxUAFaMmdpdGh1Yi5j",
+            "b20vYXV0aHplZC9hdXRoemVkLWdvL3Byb3RvL2F1dGh6ZWQvYXBpL3YxYgZw",
+            "cm90bzM="));
       descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData,
           new pbr::FileDescriptor[] { global::Authzed.Api.V1.CoreReflection.Descriptor, global::Authzed.Api.V1.PermissionServiceReflection.Descriptor, global::Buf.Validate.ValidateReflection.Descriptor, global::Google.Api.AnnotationsReflection.Descriptor, global::Google.Protobuf.WellKnownTypes.StructReflection.Descriptor, global::Grpc.Gateway.ProtocGenOpenapiv2.Options.AnnotationsReflection.Descriptor, global::Validate.ValidateReflection.Descriptor, },
           new pbr::GeneratedClrTypeInfo(new[] {typeof(global::Authzed.Api.V1.WatchKind), }, null, new pbr::GeneratedClrTypeInfo[] {
             new pbr::GeneratedClrTypeInfo(typeof(global::Authzed.Api.V1.WatchRequest), global::Authzed.Api.V1.WatchRequest.Parser, new[]{ "OptionalObjectTypes", "OptionalStartCursor", "OptionalRelationshipFilters", "OptionalUpdateKinds" }, null, null, null, null),
-            new pbr::GeneratedClrTypeInfo(typeof(global::Authzed.Api.V1.WatchResponse), global::Authzed.Api.V1.WatchResponse.Parser, new[]{ "Updates", "ChangesThrough", "OptionalTransactionMetadata", "SchemaUpdated", "IsCheckpoint" }, null, null, null, null)
+            new pbr::GeneratedClrTypeInfo(typeof(global::Authzed.Api.V1.WatchResponse), global::Authzed.Api.V1.WatchResponse.Parser, new[]{ "Updates", "ChangesThrough", "OptionalTransactionMetadata", "SchemaUpdated", "IsCheckpoint", "FullRevisionMetadata" }, null, null, null, null)
           }));
     }
     #endregion
@@ -82,7 +84,7 @@ public enum WatchKind {
 
   #region Messages
   /// <summary>
-  /// WatchRequest specifies what mutations to watch for, and an optional start snapshot for when to start
+  /// WatchRequest specifies what mutations to watch for, and an optional start point for when to start
   /// watching.
   /// </summary>
   [global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
@@ -155,9 +157,7 @@ public WatchRequest Clone() {
     /// <summary>
     /// optional_start_cursor is the ZedToken holding the point-in-time at
     /// which to start watching for changes.
-    /// If not specified, the watch will begin at the current head revision
-    /// of the datastore, returning any updates that occur after the caller
-    /// makes the request.
+    /// If not specified, the watch will start from the current SpiceDB revision time of the request ("head revision").
     /// Note that if this cursor references a point-in-time containing data
     /// that has been garbage collected, an error will be returned.
     /// </summary>
@@ -195,6 +195,8 @@ public WatchRequest Clone() {
     private readonly pbc::RepeatedField<global::Authzed.Api.V1.WatchKind> optionalUpdateKinds_ = new pbc::RepeatedField<global::Authzed.Api.V1.WatchKind>();
     /// <summary>
     /// optional_update_kinds, if specified, indicates what kinds of mutations to include.
+    /// If your SpiceDB instance is running behind a proxy that aborts idle connections,
+    /// we recommend including Checkpoints to keep the stream alive even when there are no changes.
     /// </summary>
     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -397,10 +399,10 @@ public void MergeFrom(pb::CodedInputStream input) {
   }
 
   /// <summary>
-  /// WatchResponse contains all mutation events in ascending timestamp order,
-  /// from the requested start snapshot to a snapshot
-  /// encoded in the watch response. The client can use the snapshot to resume
-  /// watching where the previous watch response left off.
+  /// WatchResponse contains all mutation events in ascending timestamp order.
+  /// This excludes relationships that were deleted because they expired.
+  /// The response includes a field that can be used to resume
+  /// watching from that point.
   /// </summary>
   [global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
   public sealed partial class WatchResponse : pb::IMessage<WatchResponse>
@@ -442,6 +444,7 @@ public WatchResponse(WatchResponse other) : this() {
       optionalTransactionMetadata_ = other.optionalTransactionMetadata_ != null ? other.optionalTransactionMetadata_.Clone() : null;
       schemaUpdated_ = other.schemaUpdated_;
       isCheckpoint_ = other.isCheckpoint_;
+      fullRevisionMetadata_ = other.fullRevisionMetadata_.Clone();
       _unknownFields = pb::UnknownFieldSet.Clone(other._unknownFields);
     }
 
@@ -458,7 +461,7 @@ public WatchResponse Clone() {
     private readonly pbc::RepeatedField<global::Authzed.Api.V1.RelationshipUpdate> updates_ = new pbc::RepeatedField<global::Authzed.Api.V1.RelationshipUpdate>();
     /// <summary>
     /// updates are the RelationshipUpdate events that have occurred since the
-    /// last watch response.
+    /// call was made, or since the point in time specified by changes_through.
     /// </summary>
     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -489,7 +492,8 @@ public WatchResponse Clone() {
     /// <summary>
     /// optional_transaction_metadata is an optional field that returns the transaction metadata
     /// given to SpiceDB during the transaction that produced the changes in this response.
-    /// This field may not exist if no transaction metadata was provided.
+    /// This field may not exist if no transaction metadata was provided, or if multiple pieces
+    /// of metadata were found during the transaction (in which case it is ambiguous which to return).
     /// </summary>
     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -532,6 +536,23 @@ public bool IsCheckpoint {
       }
     }
 
+    /// <summary>Field number for the "full_revision_metadata" field.</summary>
+    public const int FullRevisionMetadataFieldNumber = 6;
+    private static readonly pb::FieldCodec<global::Google.Protobuf.WellKnownTypes.Struct> _repeated_fullRevisionMetadata_codec
+        = pb::FieldCodec.ForMessage(50, global::Google.Protobuf.WellKnownTypes.Struct.Parser);
+    private readonly pbc::RepeatedField<global::Google.Protobuf.WellKnownTypes.Struct> fullRevisionMetadata_ = new pbc::RepeatedField<global::Google.Protobuf.WellKnownTypes.Struct>();
+    /// <summary>
+    /// full_revision_metadata contains all transaction metadata given to SpiceDB during the
+    /// revision that produced the changes in this response. Some datastores (such as CockroachDB)
+    /// can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
+    /// so this field is a list of all transaction metadata seen during the revision.
+    /// </summary>
+    [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
+    [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
+    public pbc::RepeatedField<global::Google.Protobuf.WellKnownTypes.Struct> FullRevisionMetadata {
+      get { return fullRevisionMetadata_; }
+    }
+
     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]
     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
     public override bool Equals(object other) {
@@ -552,6 +573,7 @@ public bool Equals(WatchResponse other) {
       if (!object.Equals(OptionalTransactionMetadata, other.OptionalTransactionMetadata)) return false;
       if (SchemaUpdated != other.SchemaUpdated) return false;
       if (IsCheckpoint != other.IsCheckpoint) return false;
+      if(!fullRevisionMetadata_.Equals(other.fullRevisionMetadata_)) return false;
       return Equals(_unknownFields, other._unknownFields);
     }
 
@@ -564,6 +586,7 @@ public override int GetHashCode() {
       if (optionalTransactionMetadata_ != null) hash ^= OptionalTransactionMetadata.GetHashCode();
       if (SchemaUpdated != false) hash ^= SchemaUpdated.GetHashCode();
       if (IsCheckpoint != false) hash ^= IsCheckpoint.GetHashCode();
+      hash ^= fullRevisionMetadata_.GetHashCode();
       if (_unknownFields != null) {
         hash ^= _unknownFields.GetHashCode();
       }
@@ -599,6 +622,7 @@ public void WriteTo(pb::CodedOutputStream output) {
         output.WriteRawTag(40);
         output.WriteBool(IsCheckpoint);
       }
+      fullRevisionMetadata_.WriteTo(output, _repeated_fullRevisionMetadata_codec);
       if (_unknownFields != null) {
         _unknownFields.WriteTo(output);
       }
@@ -626,6 +650,7 @@ public void WriteTo(pb::CodedOutputStream output) {
         output.WriteRawTag(40);
         output.WriteBool(IsCheckpoint);
       }
+      fullRevisionMetadata_.WriteTo(ref output, _repeated_fullRevisionMetadata_codec);
       if (_unknownFields != null) {
         _unknownFields.WriteTo(ref output);
       }
@@ -649,6 +674,7 @@ public int CalculateSize() {
       if (IsCheckpoint != false) {
         size += 1 + 1;
       }
+      size += fullRevisionMetadata_.CalculateSize(_repeated_fullRevisionMetadata_codec);
       if (_unknownFields != null) {
         size += _unknownFields.CalculateSize();
       }
@@ -680,6 +706,7 @@ public void MergeFrom(WatchResponse other) {
       if (other.IsCheckpoint != false) {
         IsCheckpoint = other.IsCheckpoint;
       }
+      fullRevisionMetadata_.Add(other.fullRevisionMetadata_);
       _unknownFields = pb::UnknownFieldSet.MergeFrom(_unknownFields, other._unknownFields);
     }
 
@@ -725,6 +752,10 @@ public void MergeFrom(pb::CodedInputStream input) {
             IsCheckpoint = input.ReadBool();
             break;
           }
+          case 50: {
+            fullRevisionMetadata_.AddEntriesFrom(input, _repeated_fullRevisionMetadata_codec);
+            break;
+          }
         }
       }
     #endif
@@ -770,6 +801,10 @@ public void MergeFrom(pb::CodedInputStream input) {
             IsCheckpoint = input.ReadBool();
             break;
           }
+          case 50: {
+            fullRevisionMetadata_.AddEntriesFrom(ref input, _repeated_fullRevisionMetadata_codec);
+            break;
+          }
         }
       }
     }