Skip to content

Added the new vocabulary file for undefined terms #1536

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

Merged
merged 8 commits into from
Aug 8, 2024

Conversation

iherman
Copy link
Member

@iherman iherman commented Jul 23, 2024

This is to settle issue #1534. Some remarks, though:

  • The PR also includes a small change on the issuer-dependent.html file, namely the VCDM reference has been updated. However, the question is whether this file is still necessary or not or, under the circumstances, should be removed.
  • I have made the changes on the /ns/credentias/.htaccess file. Because the file is not on github, it cannot be managed directly by the PR, so I copy this verbatim below. Please, give your comments here, and I will make the changes separately.
  • @msporny there is a change to be done in the repo management, too (at least I presume). At the moment, https://w3c.github.io/vc-data-model/contexts/credentials/undefined-term/v2 is a 404; I presume you have some magic with gh-pages going on which must be adapted for the new file. I am not sure what to do with this, I leave this in your able hands.

Here is the .htaccess file itself:

RewriteEngine On
RewriteBase /ns/credentials/
AddType application/ld+json .jsonld
AddType text/turtle .ttl


# The v2 of the core VCDM JSON-LD context:
RewriteRule ^v2$ https://w3c.github.io/vc-data-model/contexts/credentials/v2 [E=json,P]

# The vocabulary referred to via a @vocab statement at the end of the core VCDM JSON-LD context
# This was removed, see https://github.com/w3c/vc-data-model/pull/1536
# RewriteRule ^issuer-dependent$ https://w3c.github.io/vc-data-model/vocab/credentials/v2/issuer-dependent.html [P]

# The v2 of the example JSON-LD context, used for the examples in the VCDM specification
RewriteRule ^examples/v2$ https://w3c.github.io/vc-data-model/contexts/credentials/examples/v2 [E=json,P]
# The v2 example context file is just a @vocab statement to ns/credentials/examples
RewriteRule ^examples$ https://w3c.github.io/vc-data-model/vocab/credentials/v2/examples.html [P]
RewriteRule ^examples#$ https://w3c.github.io/vc-data-model/vocab/credentials/v2/examples.html [P]

# The v2 of the undefined term JSON-LD context, used for the undefined terms in the VCDM specification
RewriteRule ^undefined-term/v2$ https://w3c.github.io/vc-data-model/contexts/credentials/undefined-term/v2 [E=json,P]
# The v2 example context file is just a @vocab statement to ns/credentials/examples
RewriteRule ^undefined-term$ https://w3c.github.io/vc-data-model/vocab/credentials/v2/undefined-term.html [P]
RewriteRule ^undefined-term#$ https://w3c.github.io/vc-data-model/vocab/credentials/v2/undefined-term.html [P]

#### Status list additions
RewriteRule ^status$ https://www.w3.org/ns/credentials/status/ [P]

Header set Content-Type application/ld+json env=json

Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

Tweak citation reference

Co-authored-by: Ted Thibodeau Jr <[email protected]>
Copy link
Member

@msporny msporny left a comment

Choose a reason for hiding this comment

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

Overall LGTM, some minor nits before we merge.

@msporny msporny added editorial Purely editorial changes to the specification. CR1 This item was processed during CR1 labels Jul 24, 2024
Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

Editorial fixups

Copy link
Contributor

@selfissued selfissued left a comment

Choose a reason for hiding this comment

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

I believe this is a mistake. We would be better off with @vocab in the main context so there are no undefined terms.

@msporny
Copy link
Member

msporny commented Aug 1, 2024

We would be better off with @vocab in the main context so there are no undefined terms.

That ship has sailed. PR #1520, removing @vocab from the base context, was merged after considerable debate and with WG consensus.

@iherman
Copy link
Member Author

iherman commented Aug 4, 2024

The issue was discussed in a meeting on 2024-07-31

  • no resolutions were taken
View the transcript

1.3. Publish undefined-terms context URI (issue vc-data-model#1534)

See github issue vc-data-model#1534.

See github pull request vc-data-model#1536.

Manu Sporny: for next item Ivan has raised a PR, once those three are done, no more issues on VCDM.
… only thing waiting on then is for test suites to demonstrate multiple independent implementations for every feature in specification.

@iherman
Copy link
Member Author

iherman commented Aug 4, 2024

@msporny can this PR be merged (and the .htaccess file updated)?

Copy link
Contributor

@selfissued selfissued left a comment

Choose a reason for hiding this comment

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

I still prefer @vocab being in the base context but I understand that that ship has sailed.

@iherman
Copy link
Member Author

iherman commented Aug 7, 2024

The issue was discussed in a meeting on 2024-08-07

  • no resolutions were taken
View the transcript

1.1. Added the new vocabulary file for undefined terms (pr vc-data-model#1536)

See github pull request vc-data-model#1536.

Brent Zundel: We have a PR we should look at.
… There are a number of requests for changes here, Ivan can you give us a summary of what the PR does?
… I encourage folks who would like changes to also jump in.

Ivan Herman: Just to say what you said here a little differently. There were a number of comments, so they have all been incorporated, so as far as I know, no more open comments.
… What it does is -- following up on the PR(s) which changed the place for the @vocab term and now there is a separate undefined term that has to be done properly and this PR handles that.
… There is one part of the PR that isn't in there which is for htaccess file changes I have to do externally.
… This will handle redirections, etc. it's not on github, won't be subject to PR, but I put a verbatim copy of the .htaccess file.
… There were some small comments incorporated on that as well, as far as I am concerned this can be merged and then I will change the .htaccess file after that.

Brent Zundel: Thanks for that summary, Ivan.
… To add a little bit more context, I believe three weeks ago this group came to consensus on and merged two PRs to make changes to add the undefined terms context and remove the @vocab from the core context.
… This PR just does administrative work to finish up those things that were done nearly a month ago.

Ivan Herman: That is correct.

Brent Zundel: Ted and Mike Jones, your reviews are still showing requests for changes, Ted your changes have been merged, Mike if you'd like to jump on the queue you can do so.

Michael Jones: Alright, I still think it's a mistake but I think the ship has sailed and I'll approve it.

Brent Zundel: Thank you Mike, I appreciate that.
… Ok, if there are no more comments on this PR, then we can look briefly at our set of issues.

Brent Zundel: https://github.com/w3c/vc-data-model/issues?q=is%3Aissue+is%3Aopen+-label%3Afuture+sort%3Aupdated-asc.

Brent Zundel: There are two remaining issues on the VCDM.
… I think the first issue will be addressed by the PR we just looked at.

@iherman
Copy link
Member Author

iherman commented Aug 8, 2024

Merging per https://www.w3.org/2017/vc/WG/Meetings/Minutes/2024-08-07-vcwg#section1-1. The .htaccess file has also been updated on the W3C server.

@iherman iherman merged commit 4898734 into main Aug 8, 2024
1 check passed
@iherman iherman deleted the add-vocab-undefined-term branch August 8, 2024 07:45
iherman added a commit that referenced this pull request Aug 8, 2024
* main:
  Added the new vocabulary file for undefined terms (#1536)
  Add explanation of securing mechanism examples.
  Remove mention of ZKP schemas since we have no examples to point to.
  Reformat status spec requirements in Status section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants