search

w3c / did-core

W3C Decentralized Identifier Specification v1.0
https://www.w3.org/TR/did-core/
Other
404 stars 94 forks source link

The definition of dereference output in Sec. 1.3 is not in sync with the definition of contentStream in Sec. 8.2 #680

Closed shigeya closed 3 years ago

shigeya commented 3 years ago

Related to PR #634, I found the following discrepancy:

In Sec.1.3: DID URL dereferencers and DID URL dereferencing

A DID URL dereferencer is a system component that takes a DID URL as input and produces a serialized resource as output.

In Sec 8.2 URL Dereferencing: contentStream

If the dereferencing function was called and successful, this MUST contain a resource corresponding to the DID URL. The contentStream MAY be a resource such as a DID Document that is serializable in one of the conformant representations, a Verification Method, a service, or any other resource format that can be identified via a MIME type and obtained through the resolution process. If the dereferencing is unsuccessful, this value MUST be empty.

Do we need to adjust the text in Sec 1.3?

If we don't need adjustment, the diagram in Sec 1.3 can be simpler :)

msporny commented 3 years ago

We don't need to adjust. The language in Section 1.3 is meant to just provide a simple overview, not be an exhaustive normative description (which is what Sec 8.2 is for). Marking this as pending close, please feel free to disagree, @shigeya.

shigeya commented 3 years ago

As far as the whole text in the section and the diagram are in sync, I'm okay. (assuming you're going to adjust the diagram in Sec. 1.3.)

shigeya commented 3 years ago

Closing this issue since I agreed.