mohpackets

About

This folder contains the schema and documentation for MoH models

Katsu API Documentation

To view the API documentation, simply open schemas/schema.md or Redoc.

To generate the schema.json file, run the following command:

python manage.py export_openapi_schema --api chord_metadata_service.mohpackets.apis.core.api | python -m json.tool > chord_metadata_service/mohpackets/docs/schemas/schema.json

To generate the schema.md file, install widdershins and then run the following command:

widdershins ./chord_metadata_service/mohpackets/docs/schemas/schema.json -o ./chord_metadata_service/mohpackets/docs/schemas/schema.md -u ./chord_metadata_service/mohpackets/docs/widdershins/templates/openapi3 -c true --omitHeader true

This will create the schema.md file with the updated documentation.

Katsu MoH data model Documentation

To regenerate the er_diagram.md file, run the following from the commandline in the current directory:

To update the model classes:

pip install pylint
pyreverse -o mmd ../models.py

To update the markdown file

python make_er_diagram.py