Skip to content

Add valid proof and JWT examples throughout specification #833

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

Closed
msporny opened this issue Nov 10, 2021 · 3 comments
Closed

Add valid proof and JWT examples throughout specification #833

msporny opened this issue Nov 10, 2021 · 3 comments
Assignees
Labels
editorial Purely editorial changes to the specification. errata Erratum for a W3C Recommendation

Comments

@msporny
Copy link
Member

msporny commented Nov 10, 2021

There are a number of examples in the specification that would benefit from having fully signed versions of those examples. PR #817 attempts to remove the proof field from the specification. My suggestion is that we go the other way, provide different "tabs" that show the raw credential, the verifiable credential (using the proof field), and the verifiable credential (as a JWT).

I have created an extension to enable this in ReSpec, here is some output from that ReSpec extension:

Raw Credential:
image

Verifiable Credential with proof:
image

Verifiable Credential as JWT:
image

I'll raise a PR to merge these examples into the specification.

@msporny msporny self-assigned this Nov 10, 2021
@TallTed
Copy link
Member

TallTed commented Nov 10, 2021

Any reason not to title the tabs the same as your headings here, i.e., "Raw Credential", "Verifiable Credential (with proof field)", and "Verifiable Credential (as JWT)" (instead of "Unsigned", "Signed (proof)", and "Signed (JWT)")? (If these labels are too wide, "Verifiable Credential" could probably be abbreviated as "VC".)

It seems that if those are clearer as img labels here, they will continue to be clearer as tab titles there...

@msporny
Copy link
Member Author

msporny commented Nov 10, 2021

It seems that if those are clearer as img labels here, they will continue to be clearer as tab titles there...

Ok, I will rename to:

  • Credential
  • Verifiable Credential (with proof field)
  • Verifiable Credential (as JWT)

I think we have enough space at the top of the example box for that.

@kdenhartog
Copy link
Member

Addressed in PR #834 - adding the errata label and closing

@kdenhartog kdenhartog added the editorial Purely editorial changes to the specification. label Dec 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Purely editorial changes to the specification. errata Erratum for a W3C Recommendation
Projects
None yet
Development

No branches or pull requests

3 participants