This template is used only when enable_gateway_map is explicitly enabled.
It should not be produced by default.
Use this page to document gateway, BFF, forwarding, path rewrite, auth gates, and final route landing points.
Typical goals:
- explain why request paths do not match final handlers directly
- clarify forwarding layers across teams
- identify rewrite and auth checkpoints
Use this page only when one of these is true:
- the user explicitly enabled
enable_gateway_map - the repository contains gateway or BFF routing logic
- path mismatch is blocking interface understanding
Recommended sections:
- gateway scope
- gateway route table
- rewrite / forward chain
- auth and policy checkpoints
- unresolved routing gaps
Recommended table:
| entry path | method | gateway/bff layer | rewrite/forward rule | final destination | evidence level | code locations |
| --- | --- | --- | --- | --- | --- | --- |Recommended chain format:
- client path -> gateway path -> rewritten path -> destination handler
If one layer is missing, say where the chain stops.
Useful items to record:
- auth middleware
- tenant or user context injection
- traffic control or allow-list logic
- version or gray-route conditions
Do not claim a final landing handler unless it is visible through code or config.
If only the gateway layer is visible:
- record the gateway rule
- mark final destination unresolved
- keep the evidence level aligned with the visible layer
Use phrases like:
Gateway entry path visibleRewrite rule confirmed in configForward chain partially closedFinal destination unresolved in current scopeAuth checkpoint visible before forwarding