schema-salad-tool1
Schema annotations for linked avro data (salad)
Overview
usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER] [--skip-schemas]
-
[--strict-foreign-properties] [--print-jsonld-context] [--print-rdfs] [--print-avro] [--print-rdf] [--print-pre] [--print-index] [--print-metadata] [--print-inheritance-dot] [--print-fieldrefs-dot] [--codegen language] [--codegen-target CODEGEN_TARGET] [--codegen-examples directory] [--codegen-package dotted.package] [--codegen-copyright copyright_string] [--codegen-spdx-copyright-text spdx_copyright_text [spdx_copyright_text ...]] [--codegen-spdx-license-identifier spdx_license_identifier] [--codegen-parser-info parser_info] [--print-oneline] [--print-doc] [--strict |
--non-strict][--verbose |--quiet|--debug][--only ONLY] [--redirect REDIRECT] [--brand BRAND] [--brandlink BRANDLINK] [--brandstyle BRANDSTYLE] [--brandinverse] [--primtype PRIMTYPE] [--version] [schema] [document ...]
positional arguments:
-
schema document
options:
-
-h, --help -
show this help message and exit
-
--rdf-serializer RDF_SERIALIZER -
Output RDF serialization format used by
--printrdf(one of turtle (default), n3, nt, xml)
-
--skip-schemas -
If specified, ignore $schemas sections.
-
--strict-foreign-properties -
Strict checking of foreign properties
-
--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
-
--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 other derived from the base URL (Java/TypeScript/.Net/Dlang only).
-
--codegen-copyright copyright_string -
Optional copyright of the input schema.
--codegen-spdx-copyright-textspdx_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)
-
--print-oneline -
Print each error message in oneline
-
--print-doc -
Print HTML schema documentation page
-
--strict -
Strict validation (unrecognized or out of place fields are error)
-
--non-strict -
Lenient validation (ignore unrecognized fields)
-
--verbose -
Default logging
-
--quiet -
Only print warnings and errors.
-
--debug -
Print even more logging
-
--only ONLY -
Use with
--print-doc, document only listed types
-
--redirect REDIRECT -
Use with
--print-doc, override default link for type
-
--brand BRAND -
Use with
--print-doc, set the 'brand' text in nav bar
-
--brandlink BRANDLINK -
Use with
--print-doc, set the link for 'brand' in nav bar
-
--brandstyle BRANDSTYLE -
Use with
--print-doc, HTML code to link to an external style sheet
-
--brandinverse -
Use with
--print-doc
-
--primtype PRIMTYPE -
Use with
--print-doc, link to use for primitive types (string, int etc)
-
--version, -v -
Print version
Releases
5 releases since Debian 9 (Stretch); the text changed 4 times.
--brand since Debian 11 (Bullseye);
--brandinverse since Debian 12 (Bookworm);
--brandlink since Debian 11 (Bullseye);
--brandstyle since Debian 12 (Bookworm);
--codegen since Debian 10 (Buster);
--codegen-copyright since Debian 12 (Bookworm);
--codegen-examples since Debian 11 (Bullseye);
--codegen-package since Debian 12 (Bookworm);
--codegen-parser-info since Debian 12 (Bookworm);
--codegen-spdx-license-identifier since Debian 13 (Trixie);
--codegen-target since Debian 11 (Bullseye);
--debug since Debian 10 (Buster);
--help since Debian 10 (Buster);
--non-strict since Debian 10 (Buster);
--only since Debian 11 (Bullseye);
--primtype since Debian 11 (Bullseye);
--print-avro since Debian 10 (Buster);
--print-doc since Debian 11 (Bullseye);
--print-fieldrefs-dot since Debian 10 (Buster);
--print-index since Debian 10 (Buster);
--print-inheritance-dot since Debian 10 (Buster);
--print-jsonld-context since Debian 10 (Buster);
--print-metadata since Debian 10 (Buster);
--print-oneline since Debian 10 (Buster);
--print-pre since Debian 10 (Buster);
--print-rdf since Debian 10 (Buster);
--print-rdfs since Debian 10 (Buster);
--quiet since Debian 10 (Buster);
--rdf-serializer since Debian 10 (Buster);
--redirect since Debian 11 (Bullseye);
--skip-schemas since Debian 10 (Buster);
--strict since Debian 10 (Buster);
--strict-foreign-properties since Debian 10 (Buster);
--verbose since Debian 10 (Buster);
--version since Debian 10 (Buster);
-h since Debian 10 (Buster);
-v since Debian 10 (Buster).