docs | Generate Markdown documentation. The files are index.md plus a page for each class, slot, enum, type and function, such as classes/<name>.md, or only docs.md with single_file. |
er_diagram | Generate a Mermaid entity relationship diagram. Classes become entities, slots ranging over types and enums become their attributes, and slots ranging over classes become relationship lines. |
frictionless | Generate a Frictionless Data Package. Every class becomes a CSV table, described by its own Table Schema, and references between classes become foreign keys between the tables. The files are a datapackage.json plus one schemas/<table>.json per table. |
graphql | Generate a GraphQL schema: types, interfaces, scalars and enums, but no queries. |
json_schema | Generate a JSON Schema. |
linkml | Materialize a derived LinkML schema: imports resolved, slots pushed into attributes, and the elements out of scope pruned. |
ossie | Generate an Apache Ossie ontology, serialized as YAML or JSON. Classes become entity types, enums and named types become value types, and slots become relationships. |
owl | Generate an OWL 2 ontology, serialized as Turtle or N-Triples. Classes, slots, enums and types become OWL classes, properties, classes of individuals and datatypes, with the same IRIs as in shacl and rdfs. |
pydantic | Generate pydantic classes for the schema's JSON data. Load data with X.model_validate_json(text) and dump it with x.model_dump_json(). |
rdfs | Generate RDFS, serialized as N-Triples or Turtle. |
scala | Generate Scala classes, one file per class, enum and type. |
shacl | Generate SHACL shapes, serialized as N-Triples or Turtle. |
stats | Count the elements, their documentation, mappings and languages, and the imports. Returns a SchemaStats of model/schema-stats.yaml. |
translation | Generate translation dictionaries, in JSON, from the names in the schema to the names in the generated outputs. Useful where those names matter, such as in a query against a database that follows the schema. |
typescript | Generate TypeScript types for the schema's JSON data, with no runtime code. Load data with JSON.parse(text) as X and dump it with JSON.stringify(x). |