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

Add guidance on when to use each type #190

Merged
merged 4 commits into from
Aug 3, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,19 @@ <h2>Data Model</h2>
property, and <code>JsonSchemaCredential2023</code> for usage of a [[JSON-Schema]] represented as a
<a>verifiable credential</a>.
</p>
<p>
Implementers MAY choose to use <code>JsonSchemaCredential2023</code> when they wish to
leverage features of the [[VC-DATA-MODEL-2]]. Providing a JSON Schema as a verifiable credential is
useful when it is valuable to leverage the data model's features, answering questions such as:
<ul>
<li>Who is the author of this schema? (provided by the <code>issuer</code> property)</li>
<li>Why should the author be trusted for providing this schema? (provided by the <code>evidence</code> property)</li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you have an example of using evidence for this?
If not, please remove the evidence link.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

removed

<li>Is it schema still in use? (provided by the <code>validFrom</code>, <code>validUntil</code>, and <code>credentialStatus</code> properties)</li>
Copy link
Collaborator

@OR13 OR13 Aug 1, 2023

Choose a reason for hiding this comment

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

Suggested change
<li>Is it schema still in use? (provided by the <code>validFrom</code>, <code>validUntil</code>, and <code>credentialStatus</code> properties)</li>
<li>Is this schema still valid? (provided by the <code>validFrom</code>, <code>validUntil</code>, and <code>credentialStatus</code> properties)</li>

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

</ul>

When these features are not necessary for a given use case it is RECOMMENDED that implementers
use the <code>JsonSchema2023</code> type.
OR13 marked this conversation as resolved.
Show resolved Hide resolved
</p>
<section>
<h3>JsonSchema2023</h3>
<p>
Expand Down