Skip to content

Commit 2ced0b8

Browse files
Add client state diagram to Materialize docs.
1 parent 7be7b24 commit 2ced0b8

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

pages/authzed/concepts/authzed-materialize.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,12 @@ When this error is returned, it indicates the client should restart [LookupPermi
587587
Every previously stored data should also be discarded.
588588
If the volume of data to ingest via [LookupPermissionSets] is large enough it takes many hours to consume, please get in touch with AuthZed support to tweak your instance accordingly.
589589

590+
### Managing Client State
591+
592+
This diagram shows the various states your client application will need to transition through when calling the [LookupPermissionSets] and the [WatchPermissionSets] APIs.
593+
594+
![authzed-materialize](/images/materialize-client-state-diagram.png)
595+
590596
[WatchPermissionSets]: https://buf.build/authzed/api/docs/v1.35.0:authzed.api.materialize.v0#authzed.api.materialize.v0.WatchPermissionSetsService.WatchPermissionSets
591597
[LookupPermissionSets]: https://buf.build/authzed/api/docs/v1.35.0:authzed.api.materialize.v0#authzed.api.materialize.v0.WatchPermissionSetsService.LookupPermissionSets
592598
[LookupResources]: https://buf.build/authzed/api/docs/v1.35.0:authzed.api.v1#authzed.api.v1.PermissionsService.LookupResources
36.7 KB
Loading

0 commit comments

Comments
 (0)