README.md

Model Updater

Setup

• Make sure you have Python and pip installed on your machine.
• Install the script dependencies (JSON to markdown generator):

  • Use a virtualenv (recommended)

    # Create and use the virtualenv
    python -m venv venv
    source venv/bin/activate
    # Install the dependency
    pip install json-schema-for-humans

  • Or, install the dependency for your user

    pip install --user json-schema-for-humans

Update the models from the schemas

./generate-model-markdown.sh

Contribute

Markdown docs are generated based on templates available in json-schema-templates.

These templates use Jinja format.