docs: document rate limiting configuration, endpoints, and error format (#515) - #521
Merged
Chucks1093 merged 1 commit intoJun 27, 2026
Conversation
|
@Francis6-git Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolves #515. This PR adds comprehensive documentation regarding the server's rate-limiting behavior, default settings, protected endpoints, and error response shapes.
Unlike a per-route implementation, the codebase relies on a single global
express-rate-limitmiddleware mounted at the app root, which has been explicitly documented to guide both contributors and operators.Scope of Changes
src/middlewares/rate.middleware.ts) and proxy configuration./api/v1/...(such as alert and webhook registrations).MODEenvironment variable (productionvs. other environments).Acceptance Criteria Verification
MODE) is explainedtype,message,retryAfterSeconds,timestamp)Documentation Created
docs/rate-limiting-configuration.mdCloses #515