-
Couldn't load subscription status.
- Fork 28
Add terminology section, merge in Model #387
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
base: main
Are you sure you want to change the base?
Changes from 5 commits
5fee63c
c750a0d
91176bb
acc651e
76b6970
56d1bc3
2e361b6
fc4ded2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -435,7 +435,70 @@ <h2 class="informative"> | |||||||||||||||||||
| request data=] and [=digital credential/request data|credential request | ||||||||||||||||||||
| data=] to and from such software. | ||||||||||||||||||||
| </li> | ||||||||||||||||||||
| </ul><!-- | ||||||||||||||||||||
| </ul> | ||||||||||||||||||||
| <!-- | ||||||||||||||||||||
| // MARK: Terminology | ||||||||||||||||||||
| --> | ||||||||||||||||||||
| <h2> | ||||||||||||||||||||
| Terminology | ||||||||||||||||||||
| </h2> | ||||||||||||||||||||
| <h3>Defined by this specification</h3> | ||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
| <!-- | ||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We rely on VC 2 tho for terminology? Is the VC WG in agreement with this? We should coordinate with them on who owns the canonical definitions. Ideally, IMO, these should be owned by the W3C, as not everyone participates in the IETF. |
||||||||||||||||||||
| // NOTE: some of these will eventually reference the VDC Architecture spec from IETF | ||||||||||||||||||||
| --> | ||||||||||||||||||||
| <dl class="definitions" data-sort="ascending" data-cite=""> | ||||||||||||||||||||
| <dt> | ||||||||||||||||||||
| <dfn>Credential manager</dfn> | ||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This definition is good, but should move to the Credential Management spec. |
||||||||||||||||||||
| </dt> | ||||||||||||||||||||
| <dd> | ||||||||||||||||||||
| An application, hardware device, or service which securely stores, | ||||||||||||||||||||
| organizes, manages, and enables presentation of credentials. Digital | ||||||||||||||||||||
| wallets, password managers, and passkey managers are all examples of | ||||||||||||||||||||
| credential managers. | ||||||||||||||||||||
| </dd> | ||||||||||||||||||||
|
Comment on lines
+450
to
+458
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Moved here: w3c/webappsec-credential-management#275
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Merged: Thanks for the suggested text. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Merged. |
||||||||||||||||||||
| <dt> | ||||||||||||||||||||
| <dfn>Wallet</dfn> | ||||||||||||||||||||
| <dfn>Digital wallet</dfn> | ||||||||||||||||||||
timcappalli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
timcappalli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||
| </dt> | ||||||||||||||||||||
| <dd> | ||||||||||||||||||||
| A user friendly term for a [=credential manager=] for verifiable digital | ||||||||||||||||||||
| credentials and other objects like payment cards and tickets. | ||||||||||||||||||||
| </dd> | ||||||||||||||||||||
| <dt> | ||||||||||||||||||||
| <dfn>Issuance service</dfn> | ||||||||||||||||||||
|
||||||||||||||||||||
| </dt> | ||||||||||||||||||||
| <dd> | ||||||||||||||||||||
| An entity that performs the act of creating and delivering a verifiable | ||||||||||||||||||||
| digital credential on behalf of the issuer. In many cases, the | ||||||||||||||||||||
| [=issuer=] and issuance service are the same entity or component. | ||||||||||||||||||||
| </dd> | ||||||||||||||||||||
| <dt> | ||||||||||||||||||||
| <dfn>Verification service</dfn> | ||||||||||||||||||||
|
||||||||||||||||||||
| </dt> | ||||||||||||||||||||
| <dd> | ||||||||||||||||||||
| An entity that performs the cryptographic validation of a | ||||||||||||||||||||
| [=verifiable presentation=] on behalf of the [=verifier=]. In many | ||||||||||||||||||||
| cases, the [=verifier=] and verification service are the same entity or | ||||||||||||||||||||
| component. | ||||||||||||||||||||
| </dd> | ||||||||||||||||||||
| <dt> | ||||||||||||||||||||
| <dfn>Relying party</dfn> | ||||||||||||||||||||
|
||||||||||||||||||||
| </dt> | ||||||||||||||||||||
| <dd> | ||||||||||||||||||||
| The entity which consumes and/or stores [=claims=] from a | ||||||||||||||||||||
| [=verifiable presentation=]. In many cases, the relying party and | ||||||||||||||||||||
| [=verifier=] are the same entity or component. | ||||||||||||||||||||
| </dd> | ||||||||||||||||||||
| </dl> | ||||||||||||||||||||
|
|
||||||||||||||||||||
| <h3>Defined by other specifications</h3> | ||||||||||||||||||||
| <ul> | ||||||||||||||||||||
| <li>Holder: <a href="https://www.w3.org/TR/vc-data-model-2.0/#holder">W3C Verifiable Credentials Data Model v2.0</a></li> | ||||||||||||||||||||
| <li>Issuer: <a href="https://www.w3.org/TR/vc-data-model-2.0/#issuer">W3C Verifiable Credentials Data Model v2.0</a></li> | ||||||||||||||||||||
| <li>Verifier: <a href="https://www.w3.org/TR/vc-data-model-2.0/#verifier">W3C Verifiable Credentials Data Model v2.0</a></li> | ||||||||||||||||||||
| </ul> | ||||||||||||||||||||
|
||||||||||||||||||||
| <h3>Defined by other specifications</h3> | |
| <ul> | |
| <li>Holder: <a href="https://www.w3.org/TR/vc-data-model-2.0/#holder">W3C Verifiable Credentials Data Model v2.0</a></li> | |
| <li>Issuer: <a href="https://www.w3.org/TR/vc-data-model-2.0/#issuer">W3C Verifiable Credentials Data Model v2.0</a></li> | |
| <li>Verifier: <a href="https://www.w3.org/TR/vc-data-model-2.0/#verifier">W3C Verifiable Credentials Data Model v2.0</a></li> | |
| </ul> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, as they're not displayed in the terminology section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marcoscaceres What @timcappalli is noting is the same point I was trying to make a year or two ago (sorry, can't remember the issue where we were discussing that). People expect to see terms used in the spec, and their definitions, in the terminology section. An "import from external spec" could do this for us so people don't have to jump from spec to spec, but I also understand that requires work that many of us don't have the time for right now.
So, in the meantime, linking to the definition in another spec for terms and then summarizing which terms are defined in other specs somewhere (PR #389) is a reasonable compromise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That’s not how other browser API specs work though (see any browser spec, apart from the exceptional few that didn’t get the memo)… what’s beautiful about the this “web” thing is the you can seamlessly jump around documents through “hyper links” 😝
ReSpec, Bikeshed, and the ton of infrastructure/tools we’ve at the W3C is designed around this - unapologetically opinionated so. Redefining things is redundant and highly discouraged by the tooling by design and unnecessary given hyperlinks.
Best practice is to define things once and just link. Terminology sections that just link to other specs are superfluous and require the user to click twice to get to the definition they want. Basically, “I saved you a click”.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That’s not how other browser API specs work though
Yah, they're all broken. :P (only half-joking)
Redefining things is redundant
Yes, completely agree.
Terminology sections that just link to other specs are superfluous
Agree.
Best practice is to define things once and just link.
Jumping around from document to document is the annoying thing. As the person writing a spec, can't you just show me a definition inline, or at least in the same document? Don't redefine it, just import the definition or (better) just show the definition in an overlay in the spec. I'm rehashing the discussion we had a year or so ago at this point.
When I'm reading a sentence with 5 new terms that I'm not quite sure what they mean, I don't want to have to divert to 5 different specifications to learn about those words.
In any case, this is non-blocking, wish list feedback. If we have to jump to another spec, that's fine for now, though, as a reader, it's annoying.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't redefine it, just import the definition or (better) just show the definition in an overlay in the spec. I'm rehashing the discussion we had a year or so ago at this point.
You are spot on! And yes!!!! @dontcallmedom, @tidoust, and I thought about adding this to the tooling a while back, so we do the same thing as Wikipedia does:
There's a few challenges, like where specs where spec authors were not using the dt + dd pattern correctly (looking at you Web Authn), but I think we can overcome those issues now using AI to do the extraction without bothering Editors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linking to the underlying Respec issue and current status: speced/respec#4522 (comment) (summary: the logic already exists at the data level, but isn't used for now)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thought about adding this to the tooling a while back
Excellent, then we're aligned on the goal, now it's just a simple matter of some angel finding the time to implement it, and based on @tidoust's feedback, we're closer than we were a year ago. In the meantime, we can link to other specs as you noted and folks will have to click through to the other spec to get to the definition.
I think we can overcome those issues now using AI to do the extraction without bothering Editors.
Bonus points for working AI into the conversation, that is, if you are indeed the real @marcoscaceres.
Uh oh!
There was an error while loading. Please reload this page.