ysugimoto/falco
[BUG] Documentation checker tool misses variables containing `{NAME}`
已关闭
#287 创建于 2024年4月1日
buggood first issuehelp wanted
仓库指标
- 星标
- (151 个星标)
- PR 合并指标
- (平均合并 2天 13小时) (30 天内合并 3 个 PR)
描述
Kind of proposals
- Other
Describe the problem
The documentation checking tool (cmd/documentation-checker/ / make check) is setup to ignore all variables in the Fastly documentation pages that contain {NAME}. This is to ignore the header variables (req.http.*, etc). Which are defined in our predefined.yml file in a different format than the upstream documentation (req.http.%any% vs req.http.{NAME}).
This prevented the tool from noticing variables such as backend.{NAME}.healthy.
Possible solution
This could be fixed by making header regex check more specific to match only the header variables or by removing the regex and instead converting the upstream format to match ours.