positional arguments:¶

schema document

options:¶

-h, --help

show this help message and exit

--rdf-serializer RDF_SERIALIZER

Output RDF serialization format used by --print-rdf (one of `turtle` (default), `n3`, `nt`, `xml`)

--skip-schemas

If specified, ignore `$schemas` sections.

--strict-foreign-properties

Strict checking of foreign properties

--version, -v

Print version

Output type and format:¶

--print-jsonld-context

Print JSON-LD context for schema

--print-rdfs

Print RDF schema

--print-avro

Print Avro schema

--print-rdf

Print corresponding RDF graph for document

--print-pre

Print document after preprocessing

--print-index

Print node index

--print-metadata

Print document metadata

--print-inheritance-dot

Print graphviz file of inheritance

--print-fieldrefs-dot

Print graphviz file of field refs

--codegen LANGUAGE

Generate classes in target language, currently supported: `python`, `java`, `typescript`, `dotnet`, `cpp`, `dlang`

--print-oneline

Print each error message in oneline

--print-doc

Print HTML schema documentation page

Code generation configuration:¶

Requires --codegen LANGUAGE

--codegen-target CODEGEN_TARGET

Defaults to `sys.stdout` for Python/C++/Dlang and `./` for Java/TypeScript/.Net

--codegen-examples DIRECTORY

Directory of example documents for test case generation (Java/TypeScript/.Net/Dlang only).

--codegen-package DOTTED.PACKAGE

Optional override of the package name which is otherwise derived from the base URL (Java/TypeScript/.Net/Dlang only).

--codegen-copyright COPYRIGHT_STRING

Optional copyright of the input schema.

--codegen-spdx-copyright-text SPDX_COPYRIGHT_TEXT [SPDX_COPYRIGHT_TEXT ...]

List of copyright text. Each entry will show up as `SPDX-FileCopyrightText: ...` (Currently C++ only)

--codegen-spdx-license-identifier SPDX_LICENSE_IDENTIFIER

Optional spdx license identifier, e.g.: GPL-3.0-only (Currently C++ only)

--codegen-parser-info PARSER_INFO

Optional parser name which is accessible via resulted parser API (Python and Dlang only)

Validation strictness:¶

--strict

Strict validation (unrecognized or out of place fields are error)

--non-strict

Lenient validation (ignore unrecognized fields)

Logging detail level:¶

--verbose

Default logging

--quiet

Only print warnings and errors.

--debug

Print even more logging

Documentation generation options:¶

Requires --print-doc

--only ONLY

Document only listed types

--redirect REDIRECT

Override default link for type

--brand BRAND

Set the 'brand' text in nav bar

--brandlink BRANDLINK

Set the link for 'brand' in nav bar

--brandstyle BRANDSTYLE

HTML code to link to an external style sheet

--brandinverse

Set to use the dark navigation bar style.

--primtype PRIMTYPE

Link to use for primitive types (string, int etc)