Skip to main content

JADN schema tools

Project description

JADN is used to process Information Models as described in RFC 8477, and to validate and serialize Information objects. The software is organized by function:

  • core: Load, validate, and save a JADN schema.

  • codec: Validate, encode, and decode application information using a specified data format:

    • Idiomatic (verbose) JSON

    • Minimized (concise) JSON

    • CBOR*

    • XML*

  • convert: Convert JADN schema between JSON and documentation formats:

    • text-based Interface Definition Language (IDL)

    • html tables

    • markdown tables

  • transform: Process a JADN schema to produce another JADN schema:

    • combine definitions from separate schemas into a single schema

    • split a schema that defines multiple objects into separate schemas for each object

    • remove unused definitions

    • delete or truncate comments

  • translate: Convert a JADN schema into a concrete schema language:

    • JSON Schema

    • XSD*

    • CDDL*

    • Protobuf*

* Planned

Quickstart

The quickstart.py script from https://github.com/davaya/jadn-pypkg/tree/master/distribution illustrates how to use these functions:

  • define and validate a schema

  • convert the schema into documentation formats

  • truncate comments

  • translate JADN to JSON Schema

  • validate and serialize test messages to:

    • JSON data format

    • Minimized-JSON data format

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jadn-0.5.7.tar.gz (40.6 kB view hashes)

Uploaded Source

Built Distribution

jadn-0.5.7-py3-none-any.whl (46.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page