diff --git a/docs/ecolyo-agent/technical/api_routes.md b/docs/ecolyo-agent/technical/api_routes.md index 1079ce84eba73f34889e554d0315fa1f518b2196..82daf7ffed5d392c87253db8df8659055838cf96 100644 --- a/docs/ecolyo-agent/technical/api_routes.md +++ b/docs/ecolyo-agent/technical/api_routes.md @@ -1,6 +1,4 @@ # API Routes -:warning: WIP :warning: - -The different routes exposed by the backend are described by Swagger documentation. -Once the api deployed, the documentation is accessible at https://HOSTNAME/swagger/index.html +The different routes exposed by the backend are described by Swagger documentation in local env. The documentation is NOT exposed in REC or PROD. +Once the client is deployed, the documentation is accessible at <https://localhost/doc/> diff --git a/mkdocs.yml b/mkdocs.yml index b806518e33f7ebcc576357dd47bddbdb172dcd22..15472df619ac929fae9769d43c47ee9bce9dc4c1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -101,7 +101,7 @@ nav: - Technical: - Getting started: ecolyo-agent/technical/getting_started.md - Deploy: ecolyo-agent/technical/deploy.md - - âš ï¸ API Routes: ecolyo-agent/technical/api_routes.md + - API Routes: ecolyo-agent/technical/api_routes.md - Handle assets: ecolyo-agent/technical/handle_assets.md - Backup: ecolyo-agent/technical/backup.md - Libraries: ecolyo-agent/technical/libraries.md