Skip to content

Vocabulary pruning and improvement phase 1 #127

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 3 commits into from
Jul 28, 2023
Merged

Conversation

iherman
Copy link
Member

@iherman iherman commented Jul 21, 2023

This is the first of several steps to clean up the Security Vocabulary. The main changes are:

  • Anchors have been added to all term definition to allow for an external reference. That is the only change on the spec text itself, no content has been changed. Note that this covers the same ground as (Editorial) systematically adding an anchor to each property vc-data-model#1080 but adapted to the date integrity case
  • For all properties, and also for some of the classes, a defined by tag has been added in the (YAML) vocabulary definition. This is translated into the rdfs:isDefinedBy statement in the formal vocabularies, and a textual translation thereof in the HTML text. Any other text in the property definitions had been removed. Bottom line: the official term definition is the in VCWG specifications, the vocabulary just "refers" to that. Some additional comments:
    • The starting point of the vocabulary was the CCG text which was pruned significantly, but kept, as deprecated or reserved terms, those that, in our information, are in use out there (but not formally defined by a VCWG spec). Welcome on possibly more to-be-removed or not-to-be-removed terms would be welcome…
    • There are three terms in the vocabulary, namely proof, nonce and revoked, that have no formal definition, but are used, or to-be-used in our spec as well. The vocabulary have comments on this, and these must be solved asap
    • All official terms are actually defined in the DI spec. The only exceptions are the Ed25519VerificationKey2020 and Ed25519Signature2020 classes that are defined in a normative Appendix of eddsa.
    • The deprecated terms refer back to the ccg specification.
    • Some classes have no direct reference in the spec, their roles are, sort of, "scaffolding" in the vocabulary. This is perfectly fine, they are intermediary classes and carry no other role.
    • The definition of deprecated terms is kept to the bare minimum. In particular, no range or domain statement on other elements on the vocabulary are kept. After all, these are mostly placeholder items, to avoid 404-s on their relevant identifiers.
    • This part of the PR is the counterpart of Add references in vocabulary that link back to the VCDM document vc-data-model#1061 for the security vocabulary. It also runs in parallel with Vocabulary improvement Phase 1 vc-data-model#1209.
    • The PR is also relevant to Add hashes for context and vocab files. #116 see, in particular, Add hashes for context and vocab files. #116 (comment)

For reviewers

The PR does not include the visible files, i.e., the vocabulary in HTML/JSON-LD/Turtle. This is because the generation of these files happen automatically by a GitHub action. To make the reviews possible:

  • The files have been generated separately, and can be reached from the relevant index file in the tool repository for review.
  • The textual changes are to be made on the vocab/credentials/v2/vocabulary.yml and, for the text framework in the generated HTML, on the vocab/credentials/v2/template.html files. (These are the vocabulary generation input files.)

Preview | Diff

@iherman iherman requested a review from msporny as a code owner July 21, 2023 10:05
@iherman
Copy link
Member Author

iherman commented Jul 24, 2023

Note: the problem of the missing nonce specification may be solved by PR #122

Cc @Wind4Greg

These were originally done for the vcdm vocabulary, but equally valid here.
@iherman
Copy link
Member Author

iherman commented Jul 26, 2023

I believe all outstanding questions/suggestions have been addressed (some of them came through comments in w3c/vc-data-model#1209). From my point of view, this is ready to be merged...

@msporny
Copy link
Member

msporny commented Jul 28, 2023

Normative, multiple reviews, changes requested and made, no objections, merging.

@msporny msporny merged commit 3f9b0b2 into main Jul 28, 2023
@msporny msporny deleted the vocab/pruning-improving branch July 28, 2023 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants