From 8efa4bd2f4f2a774e132a3ca3b11bb805849a5eb Mon Sep 17 00:00:00 2001 From: Heitor Rosa Date: Sat, 25 Apr 2026 22:51:35 -0300 Subject: [PATCH] docs: document api docs and rate limiting in readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index fe38e3c..48e633b 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,18 @@ Implemented and in-progress use cases: --- +## API Documentation + +The core system exposes an interactive API documentation using Swagger. When the application is running, the documentation is available at `/docs`. This allows for exploration of all available endpoints, request schemas, and response types. + +--- + +## Rate Limiting + +To ensure stability and protect the system against abuse, the API implements request rate limiting. Using NestJS Throttler, limits are enforced at the HTTP layer, mitigating brute-force attempts and denial-of-service scenarios. + +--- + ## Documentation * ADRs (architectural decisions): [`docs/adr`](./docs/adr)