Updated the URL-s in the vocabulary #212
Conversation
iherman
requested review from
msporny,
Wind4Greg and
seabass-labrax
as code owners
iherman
added
the
CR1
vocab/security/vocabulary.drawio
Outdated
| <mxCell style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=none;strokeWidth=2;" parent="1" vertex="1"> | ||
| <mxGeometry x="555.3489294710328" y="440.29808823529413" width="163.7314231738035" height="32.536500000000004" as="geometry" /> | ||
| </mxCell> | ||
| </UserObject> | ||
| <UserObject label="<i>expires</i>" link="https://w3.org/2018/credentials/#expires" id="Uf8WLKuzS3drS_BCJ-BJ-12"> | ||
| <UserObject label="<i>expires</i>" link="https://w3id.org/security#expires" id="Uf8WLKuzS3drS_BCJ-BJ-12"> |
There was a problem hiding this comment.
This should be "expiration" ... but perhaps not for this PR. The context term is "expires" but the URL uses "#expiration". It's a unicorn, but has been in use for years that way.
| <UserObject label="<i>expires</i>" link="https://w3id.org/security#expires" id="Uf8WLKuzS3drS_BCJ-BJ-12"> | |
| <UserObject label="<i>expires</i>" link="https://w3id.org/security#expiration" id="Uf8WLKuzS3drS_BCJ-BJ-12"> |
There was a problem hiding this comment.
@dlongley Ah. So the term is expires in the spec, and, indeed, the @context uses expiration in the URL. Ouch.
There seems to be two ways to change this:
- Set the URL in the vocabulary to
expirationrather thanexpires(the fact that the diagram usesexpiresis only an artifact). That means the vocabulary will be at odds with what the spec says, which is ugly. - Update the
@contextfile to the right ID
The second option seems to be the correct way of doing this. Any reason why we should not?
(But yes, I believe we should leave this for a separate PR.)
There was a problem hiding this comment.
The second option seems to be the correct way of doing this. Any reason why we should not?
Yes, the reason not to do it is that many things have shipped / escaped into the wild using #expiration in the URL. The contexts have been that way for a long while and we should probably just embrace it. The vocab was erroneously changed to use #expires in some recent update that no one picked up on because it is a special unicorn -- and it should be changed back to #expiration, IMO. It's not pretty, but it is the way it's been done for a long time now and I don't think it buys us much to try and change to #expires -- with any number of possible issues coming up in the ecosystem if we do.
There was a problem hiding this comment.
I am holding my nose but... I will do it tomorrow. It is more than what you put there as a change request: the change must also be made in the svg file and, more importantly, in the vocabulary.yml file as well.
There was a problem hiding this comment.
@dlongley @msporny I have made the expires -> expiration change in 8afd6b9.
I was wondering whether we should put a small text as a comment into the vocabulary file explaining why, if one dereferences the definition link, one gets to the term expires in the VCDM spec. Because it seems to have a historical background, I would prefer one of you two to propose a text. Alternatively, we may remain silent...
(If you decide that a text is better, you can directly edit the yml file by adding a comment: field to the definition of expiration)
Co-authored-by: Dave Longley <[email protected]>
Co-authored-by: Ted Thibodeau Jr <[email protected]>
|
Editorial, multiple reviews, changes requested and made, no objections, merging. |
This is an editorial cleanup for the URL-s in the voabulary, following the separate discussion in w3c/vc-data-model#1296 (comment) but also w3c/vc-data-model#1296 (comment).
The generated files are not on
/TR, so this PR does not affect the current CR review.