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

Simplify abstract and move credential types to introduction. #82

Merged
merged 9 commits into from
Feb 27, 2024
28 changes: 19 additions & 9 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,12 @@
<body data-cite="credential-management-1">
<section id="abstract">
<p>
This document specifies an API to allow user agents to mediate access
to, and representing, a verifiably-issued digital credential (e.g., a
government issued digital driver's license, a passport issued by a
country, a student card or diploma issued by a university, an employee
card issued by a company, a passenger's boarding pass issued by an
airline, a profile issued by an online social network, membership
cards, vaccination records, etc) license). The API builds on
[[[credential-management-1]]] as a means to request a digital
credential from the user agent or underlying platform.
This document specifies an API to enable [=user agents=] to mediate
access to, and presentation of, digital credentials such as a driver's
license, government-issued identification card, and/or [=credential type
examples|other types of digital credential=]. The API builds on
[[[credential-management-1]]] as a means by which to request a digital
credential from a user agent or underlying platform.
</p>
</section>
<section id="sotd">
Expand All @@ -64,6 +61,19 @@ <h2>
<p>
TBW
</p>
<p id="credential-type-examples">
Copy link
Contributor

Choose a reason for hiding this comment

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

in general, share a lot of the same sentiment as expressed by @marcoscaceres. One suggestion would be to remove any specific references to the credential types in this PR, and than re-add them once we have more agreement in issue #85

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reduced the list down to the only credential type we have consensus on right now: 06271a7. Preserved the full list in #85 (comment).

There are many types of digital credential that can be conveyed using
this API. <dfn data-lt="credential type examples">
Examples of these types</dfn> include:
</p>
<ul>
<li>
a driver's license or identity card issued by a government institution
</li>
<li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm hesitant to include these at the moment because we haven't really looked at supporting these and I don't think any implementer supports these yet... though these could be supported, I'm worried about set expectations.

Copy link
Contributor Author

@msporny msporny Feb 22, 2024

Choose a reason for hiding this comment

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

I moved many of these examples down from the text that already existed in the abstract; I was attempting to preserve text that already existed. If you want to remove it, that's fine, though the utility of the API becomes less interesting for a variety of stakeholders that are watching this work closely.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 to marcos. I understand you just moved the text, but mentioning passports in this file, either here or in the intro could be sensitive.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reduced the list down to the only credential type we have consensus on right now: 06271a7. Preserved the full list in #85 (comment).

TBW: other credential types
</li>
</ul>
<h2>
Model
</h2>
Expand Down