Merge pull request #94 from authzed/improve-optional-relationsihp-filters-doc

vroldanbet · web-flow · commit b7d9cc6711a6 · 2024-03-13T17:09:07.000Z
improve Watch optional_relationship_filters docs
diff --git a/authzed/api/v1/watch_service.proto b/authzed/api/v1/watch_service.proto
@@ -46,6 +46,8 @@ message WatchRequest {
 
   // optional_relationship_filters, if specified, indicates the
   // filter(s) to apply to each relationship to be returned by watch.
+  // The relationship will be returned as long as at least one filter matches,
+  // this allows clients to match relationships on multiple filters on a single watch call.
   // If specified, optional_object_types cannot be used.
   repeated RelationshipFilter optional_relationship_filters = 3;
 }

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ message WatchRequest {`
`46`	`46`
`47`	`47`	`// optional_relationship_filters, if specified, indicates the`
`48`	`48`	`// filter(s) to apply to each relationship to be returned by watch.`
	`49`	`+ // The relationship will be returned as long as at least one filter matches,`
	`50`	`+ // this allows clients to match relationships on multiple filters on a single watch call.`
`49`	`51`	`// If specified, optional_object_types cannot be used.`
`50`	`52`	`repeated RelationshipFilter optional_relationship_filters = 3;`
`51`	`53`	`}`