Skip to content

Switched to YAML for the vocab definition #954

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
Oct 28, 2022
Merged

Switched to YAML for the vocab definition #954

merged 3 commits into from
Oct 28, 2022

Conversation

iherman
Copy link
Member

@iherman iherman commented Oct 24, 2022

This is just a technical PR with no difference in the generated content for the vocabulary. The PR aligns the VCDM vocabulary generation structure to that of the data integrity one.

The generation uses now the separate tool. Apart from sharing a tool with the security vocab, YAML is now used as the format to define the vocabulary itself. YAML is (much!) easier to edit than CSV. I do not rely on any fancy feature of YAML (like cross references), just the basic stuff. The YAML file of the vocabulary is the file that should be modified whenever the vocabulary has to be changed.

@iherman iherman requested a review from msporny as a code owner October 24, 2022 04:39
@iherman
Copy link
Member Author

iherman commented Oct 27, 2022

The issue was discussed in a meeting on 2022-10-26

  • no resolutions were taken
View the transcript

1.1. Switched to YAML for the vocab definition (pr vc-data-model#954)

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

Manu Sporny: #954, which Ivan has raised..
… To use a great new tool that he wrote, it allows you to take a YAML file and convert it to a vocabulary file. So the credential vocabulary is just generated from a really easy to use file, it's a great PR that will help us keep things up to date..
… Please take a look at it..

@iherman
Copy link
Member Author

iherman commented Oct 28, 2022

Per the comments of @msporny on the last WG call as well as those who formally approved the changes, I think it is o.k. to merge this PR.

@iherman iherman merged commit e632ab7 into main Oct 28, 2022
@iherman iherman deleted the vocab/use-yaml branch October 28, 2022 07:46
msporny pushed a commit that referenced this pull request Nov 5, 2022
* Switched to YAML for the vocab definition

* Deprecated terms well separated
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.

4 participants