Validate HSML

If you're not interested in the command line or the REST APIs for this, you can use the simple validator page on core.hsml.dev.verses.build or on spec.hsml.dev.verses.build to perform simple HSML validation on JSON-LD and TURTLE formatted data.

Step 1: Install

From the sdk zip

pip install path/to/hsml_core-VERSION-py3-none-any.whl

if you have access to VERSES internal pypi set up

pip install hsml_core

Step 2: Run the CLI

hsml_validate_jsonld path/to/file.jsonld

Example: Valid HSML

hsml_validate_jsonld simple_valid_hsml_entity_example.jsonld
# Output: JSON-LD is valid HSML.

Example: Invalid HSML

hsml_validate_jsonld simple_invalid_hsml_entity_example.jsonld
# Output: Error: Validation failed ...

Notes

You can add additional SHACL shapes to the default HSML core shapes with --shacl:

hsml_validate_jsonld myfile.jsonld --shacl custom_extension_shapes.ttl

---

Command-Line Usage (POSIX-style Help)

hsml_validate_jsonld JSONLD_FILE [--shacl SHACL_FILE [SHACL_FILE ...]]

• JSONLD_FILE: Path to the JSON-LD file to validate. This can be either a local file path or an HTTP(S) URL.

• --shacl SHACL_FILE [SHACL_FILE ...]: (Optional) Additional SHACL extension files (local paths or URLs) to validate against.

Examples:

• Validate a local file with the default schema:

  hsml_validate_jsonld myfile.jsonld

• Validate a file from a URL with a custom SHACL file:

  hsml_validate_jsonld https://example.com/data.jsonld --shacl custom_shapes.ttl

• Validate a local file with multiple SHACL files (mixing local and URL):

  hsml_validate_jsonld myfile.jsonld --shacl shapes1.ttl https://example.com/shapes2.ttl

REST API

HSML.d provides simple rest APIs for validating HSML encoded as JSON or turtle.

• You can find the full openapi spec here: core.hsml.dev.verses.build/openapi.json

• You can see/use an example of the json validation endpoint, here: core.hsml.dev.verses.build/docs#/rdfstore/validate_jsonld_rdfstore_validate_jsonld_post

• You can see an example of the turtle validation endpoint, here: core.hsml.dev.verses.build/docs#/rdfstore/validate_jsonld_rdfstore_validate_jsonld_post

If you'd like to try running it on your own computer, please see HOW TO: Start HSML.d using docker compose