Skip to content

Add section describing use of media types #1055

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Mar 7, 2023
Merged

Add section describing use of media types #1055

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3c6b8b5
chore: add section describing use of media types with syntaxes
mprorock Mar 1, 2023
b1e0616
correct spelling
mprorock Mar 1, 2023
3bab618
adjust language for clarity
mprorock Mar 1, 2023
7c81bc2
correct line breaks
mprorock Mar 1, 2023
59532a5
Apply suggestions from code review
mprorock Mar 1, 2023
76b1200
correct grammar
mprorock Mar 1, 2023
bda384a
caps for a SHOULD
mprorock Mar 6, 2023
fee2e8c
chore: open issue #1060 to discuss proof in relation to media type
mprorock Mar 7, 2023
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
35 changes: 35 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3409,6 +3409,41 @@ <h3>Syntactic Sugar</h3>
</section>

</section>
<section>
<h3>Media Types</h3>

<p>
Media types as defined in [[RFC6838]] serve a useful purpose with verifiable
credentials, especially regarding identification of a particular syntax
that is in use with a verifiable credential.
</p>
<p>
Syntaxes SHOULD be identified by a media type, and certain conventions as
outlined in this section SHOULD be followed when defining or using media types
with verifiable credentials.
</p>
<p>
Any media types associated with the core data model are listed in the section on
<a href="#iana-considerations">IANA Considerations</a> for registration with IANA.
</p>
<p class="issue" data-number="1060">
Presence of the term "verifiable" (or a shortened version) in the media type may
or may not imply a proof. Original proposed language is tracked in the issue
corresponding to this note.
</p>
<p>
Use of the term `credential` in a media type related to a syntax of verifiable
credentials <i>without</i> the corresponding use of `verifiable` as described above <i>does not</i>
imply the presence of a proof with the <a href="#dfn-credential">credential</a>.
</p>
<p>
At the time of this writing, there are two media types associated with the core data
model: `application/credential+ld+json` and `application/verifiable+credential+ld+json`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Notably, we haven't actually defined the latter one yet, but this is just an informative thing that can be changed as needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

exactly - especially given the discussion on #1034 re verifiable-credential vs verifiable+credential this gives us a good way to get aligned

Copy link
Contributor

Choose a reason for hiding this comment

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

@msporny has requested to use vc+ld+json elsewhere, which I agree with, but we can leave it like this for now I think.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
model: `application/credential+ld+json` and `application/verifiable+credential+ld+json`.
model: `application/credential+ld+json` .

Copy link
Contributor

Choose a reason for hiding this comment

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

I support this change.

Other specifications such as [[VC-JWT]] define additional media types as may be
required to allow for proper interpretation of the syntax of verifiable credentials
encoded in the syntax described by the respective specification.
</p>
</section>

<section>
<h3>Proof Formats</h3>
Expand Down