Skip to content

Commit

Permalink
docs: add component diagram that shows the process for updating a DID…
Browse files Browse the repository at this point in the history
… document
  • Loading branch information
jceb committed May 30, 2024
1 parent a423bb7 commit da2f4b1
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/figures/architecture.puml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@startuml ../public/figures/did-web-server-context
!include ./styles/styles.puml

title "Context diagram of did-web-server"
title "System Context Diagram of did-web-server"

!include ./styles/c4/C4_Context.puml
!include ./styles/sprites/icons/font-awesome-6/magnifying_glass.puml
Expand All @@ -14,14 +14,14 @@ title "Context diagram of did-web-server"
Person(admin, "Administrator", "Owner of server instance", $sprite="user_gear")
Person(person, "Person", "Controller of DID identifier", $sprite="user")
System_Ext(wallet, "Wallet", "Store of controlling keys for DID identifier", $sprite="wallet")
System(system, "did-web-server", "Self-sovereign did:web identifier store", $sprite="server")
System(server, "did-web-server", "Self-sovereign did:web identifier store", $sprite="server")
System_Ext(resolver, "DID Resolver", "did:web compatible DID resolver", $sprite="magnifying_glass")

Rel(person, wallet, "manages", "")
Rel(wallet, system, "updates DID Document", "")
Rel(wallet, server, "updates DID Document", "")
Rel(person, admin, "submits request for did:web identifier", "")
Rel(admin, system, "creates and deactivates DIDs", "")
Rel(resolver, system, "resolves DIDs", "")
Rel(admin, server, "creates and deactivates DIDs", "HTTPS")
Rel(resolver, server, "resolves DIDs", "HTTPS")

SHOW_LEGEND()
@enduml
33 changes: 33 additions & 0 deletions docs/figures/did-creation-components.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
@startuml ../public/figures/did-creation-components
!include ./styles/styles.puml

title "Component diagram for creating and updating a DID document"

!include ./styles/c4/C4_Context.puml
!include ./styles/c4/C4_Component.puml
!include ./styles/sprites/icons/font-awesome-6/magnifying_glass.puml
!include ./styles/sprites/icons/font-awesome-6/server.puml
!include ./styles/sprites/icons/font-awesome-6/key.puml
!include ./styles/sprites/icons/font-awesome-6/user_gear.puml
!include ./styles/sprites/icons/font-awesome-6/building.puml
!include ./styles/sprites/icons/font-awesome-6/file.puml
!include ./styles/sprites/icons/font-awesome-6/file_contract.puml
!include ./styles/sprites/icons/font-awesome-6/wallet.puml

System_Ext(wallet, "Wallet", "Store of controlling keys for DID identifier", $sprite="wallet")
System(server, "did-web-server", "Self-sovereign did:web identifier store", $sprite="server")
Component_Ext(key, "Cryptographic Key", "", $sprite="key")
Component(diddoc, "DID Document", "", $sprite="file")
Component(vc, "Verifiable Credential", "", $sprite="file_contract")
Component(vp, "Verifiable Presentation", "", $sprite="file_contract")

Rel(wallet, key, "stores", "")
Rel_L(vp, vc, "includes", "")
Rel_L(vc, diddoc, "includes", "")
Rel(key, vc, "signs", "")
Rel(key, vp, "signs", "")
Rel_D(vp, server, "submitted to", "HTTPS")
Rel_U(server, diddoc, "stores", "")

SHOW_LEGEND()
@enduml
Loading

0 comments on commit da2f4b1

Please sign in to comment.