Repository navigation
docs: explain route options and behavior rules - #15
Merged
Merged
Conversation
Closes #14 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E28c6iftj4hRmx55Uaaoxc Entire-Checkpoint: 01M68YZFA9NTM5E6HTV6VVAH70
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.
Closes #14
Adds a "Route policies" page (
docs/routes.md) and links it from the nav, the docs home and the usage page.What the page covers
nulldoes.rule_type,threshold,window,pattern,action,ban_duration, with units and defaults; thestatus:,json:,regex:and plain-text patterns; whatban,log,alertandthrottledo (in guard-core-php 4.4.0throttleonly logs); counting per IP and per method plus exact path; passive mode and Redis.ipinfoor Redis, lowercase exclusion entries,authRequired/apiKeyRequiredfailing without a verifier).Also fixes the README and usage wording: the default 401 ban rule counts per path, not across the
/api/v1/prefix.Verification
composer.lock). Thejson:array pattern and the route rule with a body pattern whilebehaviorScanResponseBodyis off were also run against a composer install of guard-core-php 4.4.0:json:tags[]==adminmatches,json:items[].status==errordoes not, and the route rule is accepted but never evaluated ([false,false]).mkdocs build --strict: exit 0, anchorsconfiguration.md#redisand#trusted-proxies-and-ipaddressserverparampresent.pre-commit runon the changed files: all hooks pass (markdownlint included).Docs only, no code or config change.