Rework the data model to support `statusPurpose` field. #24

msporny · 2022-03-12T19:33:41Z

This PR reworks the data model to address issue #2 and #3 by doing the following:

The type field now includes a year... StatusList2021.
The statusPurpose field has been added.
The statusPurpose field contains a text string instead of a JSON-LD typed value.
The RevocationListX and SuspensionListX types have been removed.
Two text string status purposes "revocation" and "suspension" have been added.
The JSON-LD Context and redirects have been fixed/updated.

dlongley · 2022-03-12T19:37:01Z

contexts/v1.jsonld

@@ -2,7 +2,7 @@
  "@context": {
    "@protected": true,

-    "StatusList2021Credential": {
+    "StatusListCredential2021": {


This shouldn't be changed -- this is a type of Credential not a Credential2021, so it should end in just Credential.

Suggested change

"StatusListCredential2021": {

"StatusList2021Credential": {

Yes, considered that. It's strange... can't think of anywhere else that we do this (date stamp in middle of type name). It creates this new rule that people have to remember when using date stamped values... and it's not clear when to use one vs. the other. I'd rather we stick with one rule (dates go at the end) rather than (dates sometimes go in the middle -- here's yet another complex VC thing you have to remember to determine when to do what).

The other rule we have always had is that Credential is last. This would break that rule.

Hmm, I don't think that there's a "new rule" here with date stamps. I think these have already been the rules:

If you want to date stamp a thing, X, with a year, YEAR, do XYEAR.

If you want a new type of Credential to hold / talk about X it should be XCredential. This means XYEARCredential for date stamped X's.

I don't think we're date-stamping the credential, we're date-stamping the status list. Then, as part of how this system works, we also need a credential to put the status list in. That's what the credential is ... a credential that holds a StatusList2021. It's not a credential ... from 2021 (or something?) that is holding an unstamped status list. I'm not sure what the date stamp means if it's put at the end here.

I think it's better that the rules be that the date follows the thing it applies to -- which is the status list definition. The fact that there's a credential to go along with a StatusList2021 is orthogonal, IMO.

One thing I considered was just dropping the 2021 and just making it "StatusListCredential". Thoughts?

Interesting. I get you. Seems like StatusList2021Credential agrees the "most" with naming conventions I suppose.
Other options like putting a /vYYYY/ in the path would cause issues with resolution down the line.
Seems weird, but I agree that this particular credential type is far from settled.

Seems like StatusList2021Credential agrees the "most" with naming conventions I suppose.

I count that as 2 for, 1 undecided... would be good to get some more opinions on this... /cc @OR13 @mprorock @mkhraisha @tplooker @mavarley @TallTed @peacekeeper

StatusList2021Credential being the Credential that holds the 2021 StatusList which is made up of some number of StatusList2021Entry Entries seems to make the most sense. I think it will need some clear description of how it was arrived at, something like my first sentence, to carry forward clearly into the 2022 or 2025 or 2057 editions...

Just so there is more consensus, XYearCredential seems fine to me. So StatusList2021Credential is ok. The naming convention reminds me of ECMA script standards such as ES2016 which are working fine in the javascript community.

Fixed in 01a681d.

dlongley · 2022-03-12T19:39:06Z

contexts/v1.jsonld

        "encodedList": "https://w3id.org/vc/status-list#encodedList"
      }
    },

-    "RevocationList2021Status": {
+    "StatusListEntry2021": {


It seems like this should be StatusList2021Entry, i.e., everything should be StatusList2021X.

Same comment as https://github.com/w3c-ccg/vc-status-list-2021/pull/24/files#r825341914.

Would be good to get some more opinions on this as well. /cc @OR13 @mprorock @mkhraisha @tplooker @mavarley @TallTed @peacekeeper

Fixed in 01a681d.

dlongley · 2022-03-12T19:39:49Z

contexts/v1.jsonld

      "@context": {
        "@protected": true,

        "id": "@id",
        "type": "@type",

+        "statusPurpose":
+          "https://w3id.org/vc/status-list#statusPurpose",


I'm not sure if this is better than statusType ... but maybe. Still considering.

I'm concerned about adding too many xType fields... people are going to get confused between that and the regular type field. Seems like there's good alignment with proofPurpose.

Yeah, I think this is probably a good approach.

+100 @msporny

Also agreeing here: statusPurpose is a better name than statusType which creates ambiguity with numerous other uses of the term type.

dlongley · 2022-03-12T19:40:09Z

index.html

@@ -276,7 +283,7 @@ <h2>Data Model</h2>
      </p>

      <section>
-        <h3>RevocationList2021Status</h3>
+        <h3>StatusListEntry2021</h3>


Here and throughout:

Suggested change

<h3>StatusListEntry2021</h3>

<h3>StatusList2021Entry</h3>

Same comment as https://github.com/w3c-ccg/vc-status-list-2021/pull/24/files#r825341914.

Fixed in 01a681d.

dlongley · 2022-03-12T19:41:10Z

index.html

@@ -400,25 +361,25 @@ <h3>SuspensionList2021Status</h3>
 The <code>statusListCredential</code> property MUST be a URL to a
 <a>verifiable credential</a>. When the URL is dereferenced, the resulting
 <a>verifiable credential</a> MUST have <code>type</code> property that
-includes the <code>StatusList2021Credential</code> value.
+includes the <code>StatusListCredential2021</code> value.


Here and throughout:

Suggested change

includes the <code>StatusListCredential2021</code> value.

includes the <code>StatusList2021Credential</code> value.

Same comment as https://github.com/w3c-ccg/vc-status-list-2021/pull/24/files#r825341914.

Fixed in 01a681d.

OR13 · 2022-03-17T18:28:47Z

contexts/v1.jsonld

@@ -2,7 +2,7 @@
  "@context": {
    "@protected": true,


I wonder if just include an @vocab would be a better move here.

Why do you think that, @OR13? If we do that, then everything under StatusList2021 becomes a part of the status list vocabulary. Seems like a dangerous thing to just blanket map any term to the status list vocabulary (this is why @vocab, in general, is a bad idea and shouldn't be used).

msporny requested a review from OR13 as a code owner March 12, 2022 19:33

msporny requested review from dlongley, aljones15, mavarley and mprorock March 12, 2022 19:34

msporny added 3 commits March 12, 2022 14:35

Update status list 2021 data model.

df4b864

Update JSON-LD Context to match latest specification.

82c5c53

Add "Other Links" section to respec.

fb40f90

msporny force-pushed the msporny-rework-status-purpose branch from 330ecf9 to fb40f90 Compare March 12, 2022 19:35

msporny mentioned this pull request Mar 12, 2022

Update context file URL #22

Closed

dlongley requested changes Mar 12, 2022

View reviewed changes

msporny mentioned this pull request Mar 12, 2022

Context about how this differs from 2020-rl #3

Closed

OR13 reviewed Mar 17, 2022

View reviewed changes

JSAssassin mentioned this pull request Mar 29, 2022

Add support for vc-status-list digitalbazaar/bedrock-vc-issuer#69

Closed

7 tasks

Switch to StatusList2021Entry and StatusList2021Credential.

01a681d

msporny merged commit 0853c85 into main Apr 4, 2022

msporny deleted the msporny-rework-status-purpose branch April 4, 2022 21:32

msporny mentioned this pull request Apr 4, 2022

Add status list type field #2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework the data model to support `statusPurpose` field. #24

Rework the data model to support `statusPurpose` field. #24

msporny commented Mar 12, 2022 •

edited by pr-preview bot

Loading

dlongley Mar 12, 2022

msporny Mar 12, 2022 •

edited

Loading

dlongley Mar 12, 2022

dlongley Mar 12, 2022

msporny Mar 12, 2022

sbutterfield Mar 18, 2022

msporny Mar 18, 2022

TallTed Mar 18, 2022

aljones15 Mar 29, 2022

msporny Apr 4, 2022

dlongley Mar 12, 2022

msporny Mar 12, 2022

msporny Mar 18, 2022

msporny Apr 4, 2022

dlongley Mar 12, 2022

msporny Mar 12, 2022 •

edited

Loading

dlongley Mar 12, 2022

sbutterfield Mar 15, 2022

aljones15 Mar 29, 2022 •

edited

Loading

dlongley Mar 12, 2022

msporny Mar 12, 2022

msporny Apr 4, 2022

dlongley Mar 12, 2022

msporny Mar 12, 2022

msporny Apr 4, 2022

OR13 Mar 17, 2022

msporny Mar 18, 2022

	includes the <code>StatusListCredential2021</code> value.
	includes the <code>StatusList2021Credential</code> value.

Rework the data model to support statusPurpose field. #24

Rework the data model to support statusPurpose field. #24

Conversation

msporny commented Mar 12, 2022 • edited by pr-preview bot Loading

Choose a reason for hiding this comment

msporny Mar 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msporny Mar 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aljones15 Mar 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rework the data model to support `statusPurpose` field. #24

Rework the data model to support `statusPurpose` field. #24

msporny commented Mar 12, 2022 •

edited by pr-preview bot

Loading

msporny Mar 12, 2022 •

edited

Loading

msporny Mar 12, 2022 •

edited

Loading

aljones15 Mar 29, 2022 •

edited

Loading