- HTML 79.5%
- JavaScript 16.6%
- Shell 2.5%
- Dockerfile 1.4%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
e1a5727cb7* Remove develop branch references from CI workflows Align with trunk-based development strategy per DevOps guidelines. * Remove develop branch references from deploy workflow descriptions Replace 'develop' with 'main' in workflow_dispatch input descriptions since develop branch no longer exists. |
||
| .changeset | ||
| .github | ||
| documentation | ||
| img | ||
| meta | ||
| relation | ||
| test | ||
| trifid | ||
| validation | ||
| views | ||
| .dockerignore | ||
| .gitignore | ||
| best-practice.md | ||
| build.sh | ||
| CHANGELOG.md | ||
| config.js | ||
| constraint.ttl | ||
| cube.ttl | ||
| DEVELOPMENT.md | ||
| Dockerfile | ||
| index.html | ||
| LICENSE.md | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| RELEASE.md | ||
| static.html | ||
| vocab.ttl | ||
Cube Schema
In this repository we develop the Cube Schema model.
@prefix cube: <https://cube.link/>.
DRAFT: https://zazuko.github.io/cube-link/
Validation shapes
The validation directory contains various SHACL Shapes which can be used to ensure the correctness of datasets, cubes, hierarchies, and other.
They can be retrieved from the web using a URI in the form of https://cube.link/{VERSION}/shape/{PROFILE}, where the {PROFILE} variable is replaced with any of the shape documents (without .ttl) and the {VERSION} variable is replaced with any tag name or the word latest.
It is recommended to always use a specific version to avoid breaking changes.
For example, to get version 0.0.4 of standalone-cube-constraint.ttl, fetch https://cube.link/v0.0.4/shape/standalone-cube-constraint .
Otherwise, to get the latest version, fetch https://cube.link/latest/shape/standalone-cube-constraint instead.
Finally, it is possible to request shapes from a branch or specific commit by building the URI as /ref/{REF}/shape/....
For example, to get the standalone-cube-constraint shape from the main branch, fetch https://cube.link/ref/main/shape/standalone-cube-constraint and to get it from the commit a1b2c3d4e5f6, fetch https://cube.link/ref/a1b2c3d4e5f6/shape/standalone-cube-constraint .
Published profiles
| Profile | Description |
|---|---|
| standalone-cube-constraint | Standard cube profile with minimal metadata |
| standalone-constraint-constraint | Minimal dimensions metadata. Included in standalone-cube-constraint |
| profile-opendataswiss | Cube metadata profile which follows the Opendata.swiss Handbook. Extends standalone-cube-constraint |
| profile-opendataswiss-lindas | Cube metadata for cubes published to Opendata.swiss from Lindas |
| profile-visualize | Cube metadata for cubes published to Visualize |
| basic-cube-constraint | Minimum cube. This typically isn't used directly |
How to Contribute
Please open Issues on this repository or provide PRs for contributions.
Testing
Automatic tests exist to validate cube constraints against maintained profiles, as well as tests checking the observation against given cube constraints.
Profile tests
./test/check-metadata.sh --profile=$PROFILE
$PROFILE must be the name of one of the profiles in the validation directory (without extension).
Test cases are turtle file under test/$PROFILE directory.
It is also possible to run only a subset of tests by providing a --filter argument. This argument
is a regular expression that is matched against the file name. For example, to run only basic-cube-constraint
tests which include the word "undefined":
./test/check-metadata.sh --profile=basic-cube-constraint --filter=undefined
Observation tests
./test/check-observations.sh
Test cases are turtle file under test/observations directory.
This script also supports a --filter argument.
Both scripts allow a --approved flag to force-approve the current output as valid in case of differences.