Skip to content
This repository has been archived by the owner on Oct 29, 2019. It is now read-only.

Cleanup terms around "DID scheme" #185

Closed
wants to merge 1 commit into from
Closed

Cleanup terms around "DID scheme" #185

wants to merge 1 commit into from

Conversation

rhiaro
Copy link
Member

@rhiaro rhiaro commented Mar 30, 2019

Use "DID URI scheme" and "DID method scheme" instead of "generic" and "specific" DID scheme, re: #127 (comment)


Preview | Diff

@rhiaro rhiaro added the editorial Editorial changes to the specification label Mar 30, 2019
@rhiaro rhiaro requested a review from msporny March 30, 2019 22:55
implemented for any distributed ledger or network capable of
supporting DIDs. The second purpose of this specification is to
define the conformance requirements for a DID method
specification—a separate specification that defines a specific DID
specification—a separate specification that defines a DID method
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions: Change all references to "DID method scheme" to just "DID method". Using "scheme" in both places may confuse folks. While it is true that a "DID method" is a scheme, most readers will miss the nuance and most likely use "DID URI scheme" and "DID method scheme" interchangeably.

Copy link
Member Author

@rhiaro rhiaro Mar 31, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That works in some places, but I'm not sure about the section 'DID Method Schemes' (L1919) and generally how we differentiate between when the spec is talking about the method-specific character string in the DID, and the DID method itself. Or maybe we don't need to?

Eg. "A DID method specification MUST define exactly one DID method scheme identified by exactly one method name"

Copy link
Contributor

@msporny msporny Mar 31, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would replacing that with something like: "A DID method specification MUST define further restrictions to the method and specific-idstring parameters defined in the DID URI scheme"?

The goal would be to effectively state: "There is one DID URI scheme, that's in this specification." The "DID URI scheme" may be further restricted by DID method specifications."

... or does that not address the text you're concerned about?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So while I think that generally works, I still think we need to define and use a term for what the previous spec called a "DID method scheme", i.e., the syntax (ABNF) defined by a DID method that restricts the generic DID scheme.

How about we just call it a "DID method syntax"?

Also, I want to be able to continue to use the term "generic DID syntax" for this portion of this spec so that we can mirror the same language from RFC 3986. Read these two paragraphs:

1.1.1.  Generic Syntax

   Each URI begins with a scheme name, as defined in Section 3.1, that
   refers to a specification for assigning identifiers within that
   scheme.  As such, the URI syntax is a federated and extensible naming
   system wherein each scheme's specification may further restrict the
   syntax and semantics of identifiers using that scheme.
   ...
   A parser of the generic URI syntax can parse any URI reference into
   its major components.  Once the scheme is determined, further
   scheme-specific parsing can be performed on the components.  In other
   words, the URI generic syntax is a superset of the syntax of all URI
   schemes.

So I would really like to use the same language to talk about the relationship of DIDs and DID methods, i.e., to be able to say:

The DID generic syntax is a superset of the syntax of all DID method syntaxes.

I'm drafting the proposed new text for the Decentralized Identifiers section of the spec (in this Google doc) to use this language. See what you think.

@tplooker
Copy link

@talltree great doc, with the 'service-type' and 'key-type' generic did parameter names should the description state, selects a list of services/publicKeys from the did doc?

@talltree
Copy link
Contributor

@tplooker Yes, that was the conclusion on today's DID spec call. @peacekeeper has the action item to suggest new text for those two parameter descriptions. I'm sure he'd welcome suggestions from you on that.

@rhiaro
Copy link
Member Author

rhiaro commented Apr 20, 2019

I think this PR is now superseded by #187

@peacekeeper
Copy link
Member

peacekeeper commented Apr 23, 2019

I think this PR is now superseded by #187

@rhiaro I think that's partially true, but I feel this PR here still has some good thoughts and content around the "DID scheme" terminology that the other PR doesn't fully address yet. We should probably collaborate to reconcile the two PRs.

@rhiaro rhiaro added the needs new pr Concept is good but a clean PR is needed eg. to remove conflicts label Apr 25, 2019
@rhiaro rhiaro self-assigned this Jul 18, 2019
@msporny
Copy link
Contributor

msporny commented Aug 1, 2019

The DID TF moved to close this on the 2019-08-01 call, in preference of merging PR #189.

@msporny msporny closed this Aug 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
editorial Editorial changes to the specification needs new pr Concept is good but a clean PR is needed eg. to remove conflicts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants