From ae6d6ddab5c79a1584d826bee14c7e2454fdf5f5 Mon Sep 17 00:00:00 2001 From: Bastien DUMONT <bdumont@grandlyon.com> Date: Mon, 13 May 2024 08:12:52 +0000 Subject: [PATCH] docs: remove swagger for backoffice --- docs/ecolyo-agent/Technical/libraries.md | 8 ++------ .../Technical/swagger_documentation.md | 14 -------------- 2 files changed, 2 insertions(+), 20 deletions(-) delete mode 100644 docs/ecolyo-agent/Technical/swagger_documentation.md diff --git a/docs/ecolyo-agent/Technical/libraries.md b/docs/ecolyo-agent/Technical/libraries.md index af4082f..3b53403 100644 --- a/docs/ecolyo-agent/Technical/libraries.md +++ b/docs/ecolyo-agent/Technical/libraries.md @@ -19,7 +19,7 @@ It allows to send HTTP request and manage the responses. ## Lodash -javascript utility library +JavaScript utility library Lodash modular method are great for: @@ -40,16 +40,12 @@ CSS Preprocessor It allows us to easily manage large CSS files and split across different files. It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations. -## Gorilla/Mux +## Chi Package for Go that implements a request router and dispatcher for matching incoming requests to their respective handler. It allows us to easily create and manage routes/APIs -## Swag - -Package for Go that converts annotations to Swagger Documentation 2.0. - ## Gorm ORM for Go diff --git a/docs/ecolyo-agent/Technical/swagger_documentation.md b/docs/ecolyo-agent/Technical/swagger_documentation.md deleted file mode 100644 index 9d670c6..0000000 --- a/docs/ecolyo-agent/Technical/swagger_documentation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Swagger documentation - -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/ - -To build Swagger documentation : - -- Make sure you installed swag by running : `go install github.com/swaggo/swag/cmd/swag@latest` - :::tip - If "command not found: swag" or "No such file or directory", run `export PATH=$PATH:$(go env GOPATH)/bin` - ::: -- go to server repository and run `./scripts/init-swagger-doc.sh` - -This will update `docs/swagger.json` and `docs/swagger.yaml` based on the annotations written above exposed methods. -- GitLab