Skip to content

Commit

Permalink
docs: remove local example (#9)
Browse files Browse the repository at this point in the history
Signed-off-by: Troy Ronda <troy.ronda@securekey.com>
  • Loading branch information
troyronda authored May 13, 2021
1 parent 873cbc5 commit 22bcb91
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -401,11 +401,9 @@ <h2 id="format">The did:orb Format</h2>
did-orb-format = "did:orb:" (orb-canonical-did / orb-scheme-did / unpublished-did)
orb-canonical-did = min-graph-cid ":" did-suffix
orb-scheme-did = (dht-scheme / webcas-scheme) ":" orb-canonical-did
unpublished-did = "interim:" (web-interim-scheme / local-interim-scheme)
unpublished-did = "interim:" reg-name ":" did-suffix [":" long-form-suffix-data]
dht-scheme = ( "ipfs" )
webcas-scheme = "webcas:" reg-name
web-interim-scheme = reg-name ":" did-suffix
local-interim-scheme = "local" ":" did-suffix [":" long-form-suffix-data]
reg-name = 1*idchar ; more constrained than [RFC3986]
min-graph-cid = 10*idchar ; a short 3rd segment is reserved for schemes.
did-suffix = 1*idchar
Expand Down Expand Up @@ -519,16 +517,12 @@ <h3>Propagation Delay and Canonical IDs</h3>
to return a resolution result without additional prefix information.
This situation typically occurs when there is a need to immediately use a freshly created DID suffix that hasn't yet been propagated.

<pre class="example highlight" title="Locally known DID">
did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
<pre class="example highlight" title="Not yet propagated DID only known to example.com">
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
</pre>

<pre class="example highlight" title="Long-form DID">
did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
</pre>

<pre class="example highlight" title="Not yet propagated DID only known to example.com">
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
</pre>

When an Orb Server has propagation information for a resolved DID, the server includes the <i>min-graph-cid</i> segment within the <i>canonicalId</i>
Expand All @@ -538,6 +532,11 @@ <h3>Propagation Delay and Canonical IDs</h3>
After a DID controller sends a <i>Create</i> or <i>Recover</i> operation to an Orb Server, the resolution result may have no (or an outdated) <i>min-graph-cid</i> segment.
The DID controller may need to retry resolution until the operation has been propagated and the CID becomes available.
Once the CID is available, resolution responses contain the updated <i>canonicalId</i> property.

<p class="issue" title="interim DIDs without domain">
Since Orb is based on ActivityPub, we should have a domain available for interim DIDs.
Are there cases where we would indicate no domain with a value like 'local'?
</p>
</section>

<section class="normative">
Expand Down

0 comments on commit 22bcb91

Please sign in to comment.