Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manually update katsu's OpenAPI spec to v3.0 data model #239

Merged
merged 17 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions chord_metadata_service/mohpackets/docs/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ This folder contains the schema and documentation for **MoH models**

## Katsu API Documentation

To view the API documentation, simply open [schema.md](schema.md) or [Redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/CanDIG/katsu/develop/chord_metadata_service/mohpackets/docs/schema.json).
To view the API documentation, simply open [schema.md](schema.md) or [Redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/CanDIG/katsu/feature/manual_schema/chord_metadata_service/mohpackets/docs/schema_manual.yml).

> [!IMPORTANT]
> Katsu is currently being transitioned to MoH clinical data model v3.0.0. There is a manually created v3.0.0 of the OpenAPI schema at [schema_v3.yml](schema_v3.yml) that can be used as a reference in the interim period. This file will be replaced by the automatically generated schema documentaion files once katsu is fully transitioned to model v3.0.0.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kcranston is this what you were thinking for the line in the README?


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

Expand All @@ -22,15 +25,17 @@ 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 regenerate the `er_diagram.md` file, run the following from the commandline in the current directory:

To update the model classes:

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

To update the markdown file

```bash
python make_er_diagram.py
```
Loading
Loading