Skip to content

Commit

Permalink
Merge branch 'gh-pages' into peacekeeper-dereferencing-terms
Browse files Browse the repository at this point in the history
  • Loading branch information
peacekeeper committed Dec 12, 2024
2 parents 72c1447 + 0aaa9bb commit ba11a28
Show file tree
Hide file tree
Showing 4 changed files with 356 additions and 77 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/auto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Example: Override respecConfig for W3C deployment and validators.
name: Echidna Auto-publish
on:
pull_request:
paths: ["**"]
push:
branches: [gh-pages]
paths: ["**"]
jobs:
main:
name: Echidna Auto-publish WD
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
with:
TOOLCHAIN: respec
SOURCE: index.html
VALIDATE_LINKS: false
VALIDATE_MARKUP: true
ACTIONS_STEP_DEBUG: true
W3C_ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
W3C_WG_DECISION_URL: https://www.w3.org/2024/09/24-did-minutes.html#r02
W3C_BUILD_OVERRIDE: |
specStatus: WD
shortName: did-resolution
67 changes: 35 additions & 32 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
<script type="text/javascript" class="remove">
var respecConfig = {
// specification status (e.g., WD, LCWD, NOTE, etc.). If in doubt use ED.
specStatus: "CG-DRAFT",
specStatus: "ED",

// the specification's short name, as in http://www.w3.org/TR/short-name/
shortName: "did-resolution",

// subtitle
subtitle: "Resolution of Decentralized identifiers (DIDs)",
subtitle: "Algorithms and guidelines for resolving DIDs and dereferencing DID URLs",

// if you wish the publication date to be other than today, set this
// publishDate: "2009-08-06",
Expand All @@ -45,9 +45,9 @@
// only "name" is required
editors: [
{ name: "Markus Sabadello", url: "https://www.linkedin.com/in/markus-sabadello-353a0821",
company: "Danube Tech", companyURL: "https://danubetech.com/" },
company: "Danube Tech", companyURL: "https://danubetech.com/", w3cid: 46729 },
{ name: "Dmitri Zagidulin", url: "https://www.linkedin.com/in/dzagidulin",
company: "MIT CSAIL", companyURL: "http://computingjoy.com/" }
company: "MIT CSAIL", companyURL: "http://computingjoy.com/", w3cid: 86708 }
],

// authors, add as many as you like.
Expand All @@ -56,16 +56,16 @@
authors:
[
{ name: "Markus Sabadello", url: "https://www.linkedin.com/in/markus-sabadello-353a0821",
company: "Danube Tech", companyURL: "https://danubetech.com/" },
company: "Danube Tech", companyURL: "https://danubetech.com/", w3cid: 46729 },
{ name: "Dmitri Zagidulin", url: "https://www.linkedin.com/in/dzagidulin",
company: "MIT CSAIL", companyURL: "http://computingjoy.com/" }
company: "MIT CSAIL", companyURL: "http://computingjoy.com/", w3cid: 86708 }
],

// group
group: "credentials",
group: "did",

// name (with the @w3c.org) of the public mailing to which comments are due
wgPublicList: "public-credentials",
wgPublicList: "public-did-wg",

maxTocLevel: 4,
inlineCSS: true
Expand Down Expand Up @@ -114,9 +114,9 @@
Comments regarding this document are welcome. Please file issues
directly on <a href="https://github.com/w3c/did-resolution/issues/">GitHub</a>,
or send them to
<a href="mailto:public-credentials@w3.org">public-credentials@w3.org</a>
(<a href="mailto:public-credentials[email protected]?subject=subscribe">subscribe</a>,
<a href="https://lists.w3.org/Archives/Public/public-credentials/">archives</a>).
<a href="mailto:public-did-wg@w3.org">public-did-wg@w3.org</a>
(<a href="mailto:public-did-wg[email protected]?subject=subscribe">subscribe</a>,
<a href="https://lists.w3.org/Archives/Public/public-did-wg/">archives</a>).
</p>

<p>
Expand Down Expand Up @@ -385,7 +385,7 @@ <h1>DID Resolution</h1>
<dd>
If the resolution is successful, and if the <code>resolve</code> function was
called, this MUST be a <a>DID document</a> abstract data model (a <a
data-cite="INFRA#maps">map</a>) as described in <a href=https://w3c.github.io/did-core/#data-model"></a> that
data-cite="INFRA#maps">map</a>) as described in <a href="https://w3c.github.io/did-core/#data-model"></a> that
is capable of being transformed into a <a href="https://w3c.github.io/did-core/#dfn-did-documents">conforming DID Document</a>
(representation), using the production rules specified by the representation.
The value of <code><a href="https://w3c.github.io/did-core/#dfn-id">id</a></code> in the resolved <a>DID document</a> MUST
Expand All @@ -401,7 +401,7 @@ <h1>DID Resolution</h1>
document</a> in one of the conformant
<a href="https://w3c.github.io/did-core/#representations">representations</a>. The byte stream might then be
parsed by the caller of the <code>resolveRepresentation</code> function into a
<a href=https://w3c.github.io/did-core/#data-model">data model</a>, which can in turn be validated and
<a href="https://w3c.github.io/did-core/#data-model">data model</a>, which can in turn be validated and
processed. If the resolution is unsuccessful, this value MUST be an empty
stream.
</dd>
Expand Down Expand Up @@ -469,7 +469,7 @@ <h3>DID Resolution Metadata</h3>
Type of the conformant <a>representations</a>. The
caller of the <code>resolveRepresentation</code> function MUST use this value
when determining how to parse and process the <code>didDocumentStream</code>
returned by this function into the <a href=https://w3c.github.io/did-core/#data-model">data model</a>.
returned by this function into the <a href="https://w3c.github.io/did-core/#data-model">data model</a>.
</dd>
<dt>
error
Expand Down Expand Up @@ -1056,13 +1056,6 @@ <h2>Dereferencing the Resource</h2>
<li>Return the <var>output <a>service endpoint</a> URL</var>.</li>
</ol>
</li>

<p class="issue" data-number="85">There have been discussions whether in addition to the DID parameter <code>service</code>,
there could also be a DID parameter <code>serviceType</code> to select services based
on their type rather than ID.
See <a href="https://lists.w3.org/Archives/Public/public-credentials/2019Jun/0028.html">
comments by Dave Longley</a> about `serviceType`.</p>

<li>Otherwise, if the <var>input <a>DID URL</a></var> contains a <a>DID path</a> and/or <a>DID query</a>:
<pre class="example nohighlight">did:example:1234/custom/path?customquery</pre>
<ol class="algorithm">
Expand All @@ -1081,6 +1074,13 @@ <h2>Dereferencing the Resource</h2>
</ol>
</li>
</ol>

<p class="issue" data-number="85">There have been discussions whether in addition to the DID parameter <code>service</code>,
there could also be a DID parameter <code>serviceType</code> to select services based
on their type rather than ID.
See <a href="https://lists.w3.org/Archives/Public/public-credentials/2019Jun/0028.html">
comments by Dave Longley</a> about `serviceType`.</p>

</section>

<section id="dereferencing-algorithm-fragment">
Expand All @@ -1100,25 +1100,27 @@ <h2>Dereferencing the Fragment</h2>
the <var>output <a>service endpoint</a> URL</var> "inherits" the <a>DID fragment</a> of the
<var>input <a>DID URL</a></var>.</li>
<li>Return the <var>output <a>service endpoint</a> URL</var>.</li>
<p class="note">
This behavior of the <a>DID fragment</a> is analogous to the handling of a fragment in an HTTP URL in the
case when dereferencing it returns an HTTP <code>3xx</code> (Redirection) response with a
<code>Location</code> header (see section 7.1.2 of [[RFC7231]].
</p>
</ol>
<li>Otherwise, dereference the DID fragment as defined by the media type ([[RFC2046]]) of the resource.
For example, if the resource is a representation of a DID document with media type <code>application/did</code>, then
the fragment is treated according to the rules associated with the
<a href="https://www.w3.org/TR/json-ld11/#iana-considerations">JSON-LD 1.1: application/ld+json media type</a>
[JSON-LD11].
</li>
<p class="note">
This use of the <a>DID fragment</a> is consistent with the definition of the fragment identifier in
[[RFC3986]]. It identifies a <em>secondary resource</em> which is a subset of the <em>primary resource</em>
(the <a>DID document</a>).
</p>
</ol>

<p class="note">
This use of the <a>DID fragment</a> is consistent with the definition of the fragment identifier in
[[RFC3986]]. It identifies a <em>secondary resource</em> which is a subset of the <em>primary resource</em>
(the <a>DID document</a>).
</p>

<p class="note">
This behavior of the <a>DID fragment</a> is analogous to the handling of a fragment in an HTTP URL in the
case when dereferencing it returns an HTTP <code>3xx</code> (Redirection) response with a
<code>Location</code> header (see section 7.1.2 of [[RFC7231]].
</p>

</section>

</section>
Expand Down Expand Up @@ -1835,7 +1837,7 @@ <h2>HTTP(S) Binding</h2>
<a href="#resolving"></a>) and/or <a>DID URL dereferencing</a> function (see <a href="#dereferencing"></a>)
can be executed as follows:</p>
<ol class="algorithm">
<li>Initialize a <var>request HTTP(S) URL</var> with the <var><a>DID resolver</a> HTTP(S) endpoint</var>.</li>
<li>Initialize a <var>request HTTP(S) URL</var> with the <var><a>DID resolver</a> HTTP(S) endpoint</var>.
<ol class="algorithm">
<li>Append the <var>input <a>DID</a></var> or
<var>input <a>DID URL</a></var> to the <var>request HTTP(S) URL</var>. Certain characters
Expand All @@ -1846,6 +1848,7 @@ <h2>HTTP(S) Binding</h2>
<li>Encode all other resolution options as
query parameters in the <var>request HTTP(S) URL</var>.</li>
</ol>
</li>
<li>Execute an HTTP <code>GET</code> request on the <var>request HTTP(S) URL</var>.</li>
<li>Dereference the <var>input <a>DID</a></var> or <var>input <a>DID URL</a></var> by executing the
<a>DID URL dereferencing</a> algorithm as defined in <a href="#dereferencing"></a></li>
Expand Down
Loading

0 comments on commit ba11a28

Please sign in to comment.