ReferenceΒΆ

Exact behaviour, organised by interface. These pages describe what each thing does and what its arguments mean; they do not explain why you would want it. For that, see the how-to guides and Explanation.

Interface

Stability

Contents

CLI reference

Stable

Every command and flag of the shifty binary.

Python API reference

Stable

The pyshifty validation, inference, and prepared-validator API.

C++ API reference

Stable

The C++17 static library: dataset, prepared validator, evidence sessions, and the shape-map vocabulary.

Evidence reference

Stable

The evidence data model: sessions, runs, polarity, projections, and serialization.

Shape map reference

Stable

Typed keys, bindings, and terms.

Feature support

Stable

Which parts of SHACL Core and SHACL-AF are implemented, and what happens at the edges.

Repair reference

Experimental

Sessions, templates, holes, plans, deltas, and the validation gate.

Stable means compatibility is intended across minor releases. Experimental APIs may change as their semantics and use cases settle.

The Rust API is documented separately on docs.rs/shifty-engine.