From 670facae38caddb404a63831c470d61d9858898f Mon Sep 17 00:00:00 2001 From: Ronak Thacker Date: Fri, 14 Jul 2023 16:31:34 +0530 Subject: [PATCH] feat: added end user documentation --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 81ba1801b..4aa66ab68 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,11 @@ When you just run `task` without parameters, you will see all tasks available. 5. Click on "Authorize" and "close" 6. MIW is up and running +# End Users +See OpenAPI documentation, which is automatically created from +the source and available on each deployment at the `/docs` endpoint +(e.g. locally at http://localhost:8000/docs). An export of the JSON +document can be also found in [docs/openapi_v001.json](docs/openapi_v001.json). ## Test Coverage