Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor DID Core specification based on DID WG F2F consensus. #186

Merged
merged 26 commits into from
Feb 11, 2020
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
0cb6572
Add sections for DID WG F2F reworked spec outline.
msporny Feb 6, 2020
d5d8415
Migrate content to Generic DID Syntax section.
msporny Feb 6, 2020
3d82b42
Migrate DID explanation to Identifier section.
msporny Feb 6, 2020
1f6ef69
Migrate content to Generic DID Parameters section.
msporny Feb 6, 2020
8ac4d2d
Move Identifier sub-section to DID Documents section.
msporny Feb 6, 2020
8ac574c
Migrate DID Document explanation to Architecture section.
msporny Feb 6, 2020
0fa1d89
Migrate public keys intro to DID Document section.
msporny Feb 6, 2020
61a5535
Migrate public key content into Core Data Model section.
msporny Feb 6, 2020
6eb77f2
Migrate method-specific parameter section to Identifier section.
msporny Feb 6, 2020
cae8e95
Migrate Path subsection to Identifier section.
msporny Feb 6, 2020
5a3b821
Migrate query subsection to Identifier section.
msporny Feb 6, 2020
135d8e7
Migrate fragment subsection to Identifier section.
msporny Feb 6, 2020
c6b247c
Migrate persistence subsection to Identifier section.
msporny Feb 6, 2020
04f3dcd
Migrate @context subsection to JSON-LD section.
msporny Feb 6, 2020
5abf894
Move JSON-LD extensibility subsection into JSON-LD section.
msporny Feb 6, 2020
55ee500
Migrate Identifiers subsection to Core Properties.
msporny Feb 6, 2020
eedb6f7
Remove commented out delegates subsection.
msporny Feb 6, 2020
70e5b48
Move DID Subject subsection to Core properties section.
msporny Feb 6, 2020
8093178
Move Authentication and Authorization subsections to Core Properties.
msporny Feb 6, 2020
79e8d75
Migrate created/updated subsections to Core Properties section.
msporny Feb 6, 2020
a45598c
Migrate proof subsection to Core Properties.
msporny Feb 6, 2020
433a3e7
Move Security/Privacy Requirements subsection into Methods section.
msporny Feb 6, 2020
f429024
Move Future Work subsection to an appendix.
msporny Feb 6, 2020
85bcd1a
Fix internal links
rhiaro Feb 10, 2020
5dce360
Rename "JSON" section to "Pure JSON".
msporny Feb 11, 2020
a982fad
Add issue noting structural refactoring.
msporny Feb 11, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Migrate method-specific parameter section to Identifier section.
  • Loading branch information
msporny committed Feb 6, 2020
commit 6eb77f242ee80aa23f3d13f53b088f2f69a3778a
129 changes: 57 additions & 72 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -840,6 +840,63 @@ <h2>Generic DID Parameters</h2>

<section>
<h2>Method-Specific 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 class="issue" data-number="35">
Consider using kebab-case style instead of colon separator,
e.g., <code>foo-bar</code> instead of <code>foo:bar</code>.
</p>

<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;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>
Expand Down Expand Up @@ -1241,83 +1298,11 @@ <h1>
Decentralized Identifiers (DIDs)
</h1>


<section>
<h2>
Method-Specific Syntax
</h2>

</section>

<section>
<h2>
Generic DID Parameter Names
</h2>

</section>

<section>
<h2>
Method-Specific DID Parameter Names
</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 class="issue" data-number="35">
Consider using kebab-case style instead of colon separator,
e.g., <code>foo-bar</code> instead of <code>foo:bar</code>.
</p>

<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;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>
</section>

<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>
<h2>
Path
Expand Down