Skip to content

Add schema file gen to README #24

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add schema file gen to README #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bc4947
Add schema file gen to README
goneall Aug 29, 2024
ffb6528
Merge branch 'JPEWdev:main' into schema-readme
goneall Aug 30, 2024
4b46e85
Correct syntax for generating the JSON Schema file
goneall Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ The available language bindings can be viewed by running:
shacl2code list
```

### Generating the JSON Schema file

`shacl2code` can generate a JSON schema with the following command:
```shell
shacl2code generate -i spdx-model.json-ld -u spdx-context.jsonld https://spdx.org/rdf/3.0.1/spdx-context.jsonld jsonschema -o json-schema-3.0.1.json
Copy link
Author

@goneall goneall Sep 3, 2024

Choose a reason for hiding this comment

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

Add -i annotations-file

```

Note that the spdx-context.jsonld file should match the model described in the spdx-model.json-ld file.

## Developing

Developing on `shacl2code` is best done using a virtual environment. You can
Expand Down