From 8a5232255f85222ab933fc307b78dd33de04520f Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Wed, 24 Jan 2024 18:03:15 +0100 Subject: [PATCH] Improved links to API doc in README --- pkgs/clan-cli/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/pkgs/clan-cli/README.md b/pkgs/clan-cli/README.md index a4a0174..9958ec5 100644 --- a/pkgs/clan-cli/README.md +++ b/pkgs/clan-cli/README.md @@ -1,4 +1,4 @@ -# clan-cli +# Starting The Backend The clan-cli contains the command line interface as well as the graphical webui through the `clan webui` command. @@ -13,6 +13,17 @@ clan webui --reload --no-open --log-level debug --populate --emulate - The `--emulate` flag will automatically run servers the database with dummy data for the fronted to communicate with (ap, dlg, c1 and c2) - To look into the emulated endpoints go to http://localhost:2979/emulate +# API Documentation + +Api documentation can be found in the folder `pkgs/clan-cli/tests/openapi_client/docs/` +For Entity object go to + +- [tests/openapi_client/docs/EntitiesApi.md](tests/openapi_client/docs/EntitiesApi.md) +- [tests/openapi_client/docs/EventmessagesApi.md](tests/openapi_client/docs/EventmessagesApi.md) +- [tests/openapi_client/docs/ServicesApi.md](tests/openapi_client/docs/ServicesApi.md) +- [tests/openapi_client/docs/ResolutionApi.md](tests/openapi_client/docs/ResolutionApi.md) +- [tests/openapi_client/docs/RepositoriesApi.md](tests/openapi_client/docs/RepositoriesApi.md) + # Building a Docker Image To build a docker image of the frontend and backend be inside the `pkgs/clan-cli` folder and execute: @@ -197,11 +208,6 @@ Runtime dependency add them into this array: The development environment created by `nix develop` or automatically by `direnv` is located at [shell.nix](shell.nix). The `shellHook` variable execute bash code. -# API Documentation - -Api documentation can be found in the folder `pkgs/clan-cli/tests/openapi_client/docs/` -For Entity object go to [tests/openapi_client/docs/EntityCreate.md](tests/openapi_client/docs/EntityCreate.md) - # Debugging When working on the backend of your project, debugging is an essential part of the development process. Here are some methods for debugging and testing the backend of your application: -- 2.51.0