From 3c6b8b5aba7094de52fc36e18f4a2ed33d07f27f Mon Sep 17 00:00:00 2001 From: mprorock Date: Wed, 1 Mar 2023 09:36:15 -0700 Subject: [PATCH 1/8] chore: add section describing use of media types with syntaxes --- index.html | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/index.html b/index.html index 070b234d0..c01824a40 100644 --- a/index.html +++ b/index.html @@ -3409,6 +3409,44 @@

Syntactic Sugar

+
+

Media Types

+ +

+ Media types as defined in [[RFC6838]] serve a useful purpose with verifiable + credentials, especially in regards to identifcation of a particular syntax + that is in use with a verifiable credential. +

+

+ 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. +

+

+ Any media types associated with the core data model are listed in the section on + IANA Considerations for registration with IANA. +

+

+ When defining a media type for use with verifiable credentials, for instance in a + specification that defines a specific syntax, use of the term `verifiable` implies + the presence of a proof with the credential. + This is also the case if the term is abbreviated, such as in `vc+ld+json`. + Use of media type identified as `verifiable` in this way MUST correspond with use + of one or more proofs with the credential. +

+

+ Use of the term `credential` in a media type related to a syntax of verifiable + credentials without the corresponding use of `verifiable` as noted above does not + imply the presence of a proof with the credential. +

+

+ 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`. + Other specifications such as [[VC-JWT]] define additional media types as may be + required to allow for proper interpertation of the syntax of verifiable credentials + encoded in the respective syntax described by the specification. +

+

Proof Formats

From b1e0616ed87390b18fae869869a1568e45fcb15d Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Wed, 1 Mar 2023 11:57:56 -0500 Subject: [PATCH 2/8] correct spelling Co-authored-by: Dave Longley --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index c01824a40..5a771d8b0 100644 --- a/index.html +++ b/index.html @@ -3443,7 +3443,7 @@

Media Types

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`. Other specifications such as [[VC-JWT]] define additional media types as may be - required to allow for proper interpertation of the syntax of verifiable credentials + required to allow for proper interpretation of the syntax of verifiable credentials encoded in the respective syntax described by the specification.

From 3bab618bcd624da0befe602b1fcf0a8d579875b5 Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Wed, 1 Mar 2023 11:59:15 -0500 Subject: [PATCH 3/8] adjust language for clarity Co-authored-by: Dave Longley --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 5a771d8b0..9e6e7792b 100644 --- a/index.html +++ b/index.html @@ -3430,7 +3430,7 @@

Media Types

When defining a media type for use with verifiable credentials, for instance in a specification that defines a specific syntax, use of the term `verifiable` implies the presence of a proof with the credential. - This is also the case if the term is abbreviated, such as in `vc+ld+json`. + This is also the case if the term is abbreviated in accordance with other specs, such as in `vc+ld+json`. Use of media type identified as `verifiable` in this way MUST correspond with use of one or more proofs with the credential.

From 7c81bc216866de679555ab39413dcc4b647500f5 Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Wed, 1 Mar 2023 11:59:34 -0500 Subject: [PATCH 4/8] correct line breaks Co-authored-by: Dave Longley --- index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 9e6e7792b..86a390d6e 100644 --- a/index.html +++ b/index.html @@ -3431,8 +3431,8 @@

Media Types

specification that defines a specific syntax, use of the term `verifiable` implies the presence of a proof with the credential. This is also the case if the term is abbreviated in accordance with other specs, such as in `vc+ld+json`. - Use of media type identified as `verifiable` in this way MUST correspond with use - of one or more proofs with the credential. + Use of media type identified as `verifiable` in this way MUST correspond with + the use of one or more proofs with the credential.

Use of the term `credential` in a media type related to a syntax of verifiable From 59532a5c06eab1747864bd3b0aef810917dc9038 Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Wed, 1 Mar 2023 14:18:25 -0500 Subject: [PATCH 5/8] Apply suggestions from code review Co-authored-by: Ted Thibodeau Jr --- index.html | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/index.html b/index.html index 86a390d6e..7f16182ab 100644 --- a/index.html +++ b/index.html @@ -3414,7 +3414,7 @@

Media Types

Media types as defined in [[RFC6838]] serve a useful purpose with verifiable - credentials, especially in regards to identifcation of a particular syntax + credentials, especially regarding identification of a particular syntax that is in use with a verifiable credential.

@@ -3427,16 +3427,17 @@

Media Types

IANA Considerations for registration with IANA.

- When defining a media type for use with verifiable credentials, for instance in a - specification that defines a specific syntax, use of the term `verifiable` implies + When defining a media type for use with verifiable credentials — for instance, in a + specification that defines a specific syntax — use of the term `verifiable` implies the presence of a proof with the credential. - This is also the case if the term is abbreviated in accordance with other specs, such as in `vc+ld+json`. + This also applies when the term is abbreviated, as in other specifications, + such as in the [[VC-JWT]] specification's use of `vc+ld+json`. Use of media type identified as `verifiable` in this way MUST correspond with the use of one or more proofs with the credential.

Use of the term `credential` in a media type related to a syntax of verifiable - credentials without the corresponding use of `verifiable` as noted above does not + credentials without the corresponding use of `verifiable` as described above does not imply the presence of a proof with the credential.

@@ -3444,7 +3445,7 @@

Media Types

model: `application/credential+ld+json` and `application/verifiable+credential+ld+json`. 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 respective syntax described by the specification. + encoded in the syntax described by the respective specification.

From 76b1200dd9046e5125be4283a48845047a69d0fe Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Wed, 1 Mar 2023 14:29:12 -0500 Subject: [PATCH 6/8] correct grammar Co-authored-by: Ted Thibodeau Jr --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 7f16182ab..1821be808 100644 --- a/index.html +++ b/index.html @@ -3432,7 +3432,7 @@

Media Types

the presence of a proof with the credential. This also applies when the term is abbreviated, as in other specifications, such as in the [[VC-JWT]] specification's use of `vc+ld+json`. - Use of media type identified as `verifiable` in this way MUST correspond with + Use of media types identified as `verifiable` in this way MUST correspond to the use of one or more proofs with the credential.

From bda384a1ac50fd58a6e4932f4485fa2be4af4cec Mon Sep 17 00:00:00 2001 From: Mike Prorock Date: Mon, 6 Mar 2023 16:13:03 -0500 Subject: [PATCH 7/8] caps for a SHOULD --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 1821be808..caf9ab110 100644 --- a/index.html +++ b/index.html @@ -3419,7 +3419,7 @@

Media Types

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 + outlined in this section SHOULD be followed when defining or using media types with verifiable credentials.

From fee2e8c39197ca235b02f99e146b07339d2e581f Mon Sep 17 00:00:00 2001 From: mprorock Date: Tue, 7 Mar 2023 07:17:44 -0700 Subject: [PATCH 8/8] chore: open issue #1060 to discuss proof in relation to media type --- index.html | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/index.html b/index.html index caf9ab110..10f9736aa 100644 --- a/index.html +++ b/index.html @@ -3426,14 +3426,10 @@

Media Types

Any media types associated with the core data model are listed in the section on IANA Considerations for registration with IANA.

-

- When defining a media type for use with verifiable credentials — for instance, in a - specification that defines a specific syntax — use of the term `verifiable` implies - the presence of a proof with the credential. - This also applies when the term is abbreviated, as in other specifications, - such as in the [[VC-JWT]] specification's use of `vc+ld+json`. - Use of media types identified as `verifiable` in this way MUST correspond to - the use of one or more proofs with the credential. +

+ 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.

Use of the term `credential` in a media type related to a syntax of verifiable