Skip to content

Commit 22bcb91

Browse files
authored
docs: remove local example (#9)
Signed-off-by: Troy Ronda <[email protected]>
1 parent 873cbc5 commit 22bcb91

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

index.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -401,11 +401,9 @@ <h2 id="format">The did:orb Format</h2>
401401
did-orb-format = "did:orb:" (orb-canonical-did / orb-scheme-did / unpublished-did)
402402
orb-canonical-did = min-graph-cid ":" did-suffix
403403
orb-scheme-did = (dht-scheme / webcas-scheme) ":" orb-canonical-did
404-
unpublished-did = "interim:" (web-interim-scheme / local-interim-scheme)
404+
unpublished-did = "interim:" reg-name ":" did-suffix [":" long-form-suffix-data]
405405
dht-scheme = ( "ipfs" )
406406
webcas-scheme = "webcas:" reg-name
407-
web-interim-scheme = reg-name ":" did-suffix
408-
local-interim-scheme = "local" ":" did-suffix [":" long-form-suffix-data]
409407
reg-name = 1*idchar ; more constrained than [RFC3986]
410408
min-graph-cid = 10*idchar ; a short 3rd segment is reserved for schemes.
411409
did-suffix = 1*idchar
@@ -519,16 +517,12 @@ <h3>Propagation Delay and Canonical IDs</h3>
519517
to return a resolution result without additional prefix information.
520518
This situation typically occurs when there is a need to immediately use a freshly created DID suffix that hasn't yet been propagated.
521519

522-
<pre class="example highlight" title="Locally known DID">
523-
did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
520+
<pre class="example highlight" title="Not yet propagated DID only known to example.com">
521+
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
524522
</pre>
525523

526524
<pre class="example highlight" title="Long-form DID">
527-
did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
528-
</pre>
529-
530-
<pre class="example highlight" title="Not yet propagated DID only known to example.com">
531-
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
525+
did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
532526
</pre>
533527

534528
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>
@@ -538,6 +532,11 @@ <h3>Propagation Delay and Canonical IDs</h3>
538532
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.
539533
The DID controller may need to retry resolution until the operation has been propagated and the CID becomes available.
540534
Once the CID is available, resolution responses contain the updated <i>canonicalId</i> property.
535+
536+
<p class="issue" title="interim DIDs without domain">
537+
Since Orb is based on ActivityPub, we should have a domain available for interim DIDs.
538+
Are there cases where we would indicate no domain with a value like 'local'?
539+
</p>
541540
</section>
542541

543542
<section class="normative">

0 commit comments

Comments
 (0)