Skip to content

Commit

Permalink
Remove method-specific DID parameters. Addresses #36.
Browse files Browse the repository at this point in the history
  • Loading branch information
peacekeeper authored and msporny committed Sep 7, 2020
1 parent 001abab commit 366516b
Showing 1 changed file with 5 additions and 66 deletions.
71 changes: 5 additions & 66 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@ <h3>DID URL Syntax</h3>
</p>

<section>
<h2>Generic DID URL Parameters</h2>
<h2>DID URL Parameters</h2>

<p>
The <a>DID URL</a> syntax supports a simple, generalized format for parameters
Expand All @@ -844,18 +844,14 @@ <h2>Generic DID URL Parameters</h2>
any concrete parameter names.
</p>
<p>
Some generic DID parameter names (for example, for service selection) are
Some DID parameter names (for example, for service selection) are
completely independent of any specific <a>DID method</a> and MUST always
function the same way for all <a>DIDs</a>. Other DID parameter names (for
example, for versioning) MAY be supported by certain <a>DID methods</a>, but
MUST operate uniformly across those <a>DID methods</a> that do support them.
</p>
<p>
Parameter names that are completely method-specific are described in Section
<a href="#method-specific-did-url-parameters"></a>.
</p>
<p>
The following table defines a set of generic DID parameter names.
The following table defines a set of DID parameter names.
</p>

<table class="simple">
Expand Down Expand Up @@ -939,7 +935,7 @@ <h2>Generic DID URL Parameters</h2>

<p>
Two example <a>DID URLs</a> using the <code><a>service</a></code> and
<code>version-time</code> generic DID parameters are shown below.
<code>version-time</code> DID parameters are shown below.
</p>

<pre class="example nohighlight" title="A DID URL with a 'service' DID parameter">
Expand Down Expand Up @@ -982,62 +978,6 @@ <h2>Generic DID URL Parameters</h2>

</section>

<section>
<h2>Method-Specific DID URL Parameters</h2>

<p>
A <a>DID method</a> specification MAY specify additional method-specific
parameter names. A method-specific parameter name MUST be prefixed by the method
name, as defined by the <code>method-name</code> rule.
</p>

<p>
For example, if the method <code>did:foo:</code> defines the parameter bar, the
parameter name must be <code>foo:bar</code>. An example <a>DID URL</a> using
this method and this method-specific parameter would be as shown below.
</p>

<pre class="example nohighlight">
did:foo:21tDAKCERh95uGgKbJNHYp?foo:bar=high
</pre>

<p>
A method-specific parameter name defined by one <a>DID method</a> MAY be used by
other <a>DID methods</a>.
</p>

<pre class="example nohighlight">
did:example:21tDAKCERh95uGgKbJNHYp?foo:bar=low
</pre>

<p>
Method-specific parameter names MAY be combined with generic parameter names in
any order.
</p>

<pre class="example nohighlight">
did:example:21tDAKCERh95uGgKbJNHYp?service=agent&amp;foo:bar=high
</pre>

<p>
Both <a>DID method</a> namespaces and method-specific parameter namespaces MAY
include colons, so they might be partitioned hierarchically, as defined by a
<a>DID method</a> specification. The following example <a>DID URL</a>
illustrates both.
</p>

<pre class="example nohighlight">
did:foo:baz:21tDAKCERh95uGgKbJNHYp?foo:baz:hex=b612
</pre>

<p class="issue" data-number="36">
Review what exactly we want to say about method-specific parameters
defined by one method but used in a <a>DID URL</a> with a different method.
Also discuss hierarchical method namespaces in DID parameter names.
</p>

</section>

<section>
<h2>Path</h2>

Expand All @@ -1064,8 +1004,7 @@ <h2>Query</h2>
A <a>DID query</a> is derived from a generic URI query and MUST conform to the
<code>did-query</code> ABNF rule in Section <a href="#did-url-syntax">
</a>. If a <a>DID query</a> is present, it MUST be used
as described in Sections <a href="#generic-did-url-parameters"></a> and
<a href="#method-specific-did-url-parameters"></a>.
as described in Section <a href="#generic-did-url-parameters"></a>.
</p>

<p>
Expand Down

0 comments on commit 366516b

Please sign in to comment.