doc update

konturio · Aug 22, 2023 · fc98ae6 · fc98ae6
1 parent b5dce2d
commit fc98ae6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -30,6 +30,8 @@ It is necessary to have the following environment variables properly set:
 - `TILES_CACHE_DIR_PATH` is the path for the tiles cache.
 - `PGDATABASE`, `PORT`, `PGHOST`, `PGUSER` and `PGPASSWORD` are PostgreSQL-related variables.
 
+API docs and Swagger UI url: BASE_URL/api-docs
+
 ## k8s
 
 Ready Helm configuration for mosaic tiler:

diff --git a/src/main.mjs b/src/main.mjs
@@ -389,7 +389,7 @@ app.get(
  * @openapi
  * /health:
  *   get:
- *     description: health
+ *     description: health check endpoint for monitoring that the API is running and is accessible
  *     responses:
  *       200:
  *         description: status