Repository navigation
docs(api-reference): daily api-review 2026-10-29 — drop license release_limited, add rum cumulative, monit absent_counts_as_normal - #1150
Open
flashduty[bot] wants to merge 1 commit into
Conversation
…se_limited, add rum cumulative, monit absent_counts_as_normal
4 tasks
This branch has not been deployed
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.
窗口
2026-10-28T08:12:38Z → 2026-10-29T08:03Z:起点取上一轮运行时间(不是 docs 基线提交时刻,避免「上一轮运行 → docs 基线」的盲区)。20f74d2a(2026-10-29T06:59:32Z)。origin/main读取。git diff <commit>^1 <commit>,扫json:"/binding:标签增删,再过公开面过滤(Auth == all、非/event/push/、模块未 hidden)。另对每个仓做了「窗口起点第一父 → main」的净 diff 复核。updated(3 处漂移,8 个文件
+44/−36)POST /oncall/license/listrelease_limited(properties、required、200 示例三处)07d9d2c2(PR #3408 «chore(license): remove the per-window license release quota»)把cmd/server/controller/license/info.go里三处"release_limited"全部删掉,structs.LicenseReleaseLimitedCount与structs.ReasonReleaseLimited一并移除;该字段在窗口起点(b06cdc0b)仍返回三处,故属「源码已撤、文档未跟上」的回退POST /rum/data/querycumulative0940fa4/ccd84d8(PR #415):cmd/server/controller/data/types.go的query新增Cumulative bool json:"cumulative",Validate()强制format=time_series、单一COUNT/SUM带别名、禁SELECT DISTINCT/GROUP BY/HAVING/LIMIT(.qInput.Validate返回即整请求InvalidParameter),COUNT(DISTINCT x)按首次出现桶计一次,并强制DisableSamplingPOST /rum/data/querydisable_sampling描述:新增 exact 查询槽位与BadRequest失败模式的说明2420751(PR #412)logic/dataquery/limiter.go新增exactPool/AcquireExact、errExactQueued;cache.go#runQuery用exact := q.DisableSampling && wouldSample(...)取槽;dataquery.ClientError把排队超时映射为srv.ErrBadRequest("Too many exact queries are running for this account."),落在该查询自己的error条目上POST /monit/rule/v2/{create,update,info}absent_counts_as_normal751fa80(PR #185):types/alert_rule_config_v2.go#AlertRuleThresholdV2与types/alertrulev2/contract.go#ThresholdConfig新增该字段,frontend_adapter.go双向透传;contract.go#ThresholdConfig.Validate只允许condition_clear/expression_match;pkg/edgecompat/catalog.go要求 monit-edge ≥ v0.77.0,alertRuleQueryReferenceEdgeGate不满足时以InvalidParameter拒绝保存added 0 / removed 0 个 operation:5 个 split 与 consolidated 的
paths计数不变(on-call 215 / monitors 46 / platform 28 / rum 50 / safari 53,consolidated 392),因此 未动docs.json与两份api-catalog.mdx(含 API 裸路径 redirects)。unresolved
POST /channel/incident/daily-counts:注册表有该行,handler 只在 fc-event 的origin/dev(不在origin/main),与 2026-10-12 起历次结论一致,未写入任何 spec。paths求差集,除上条外无差异(IN DOCS, NOT IN REGISTRY为空)。示例
/oncall/license/list的 200 示例data中删掉release_limited。不改项与依据
DutyError.reason(consolidated 独有,带x-flashduty-preserve-absence: true)与 safari split 的 2 处components.responses(BadRequest示例带skill_id、Forbidden示例键为accessDenied而 consolidated 为noEditPermission)为既有手改约定,按 split/consolidated 深比较(忽略键序)复核后仍是这两类,未动。LifecycleEvent.recovery_reason与RelatedResult.error属 Edge↔中心内部 lifecycle 契约,未出现在任何公开 spec;types.CheckThreshold.absent_counts_as_normal(legacy v1 结构)经查无公开 operation 可达(RuleConfigs在 monitors spec 中无任何$ref),故只改 v2 的AlertRuleThresholdV2。feat(ai-sre): unify IM target configuration(bcf3c3e1,47 文件)全部落在logic/ai_sre/*、IM notify 控制器与migration/channelconfig,属 IM 运行时配置,不触公开面。logic/charge/*催缴提醒与structs/i18n.go,非公开 API。cmd/api/benchmark*、types/benchmark*.go)在 pgy 注册表中没有任何行(grep benchmark= 0 行);/safari/onboarding/*与/onboarding/*全部auth=jwt;types/ref.go新增的RefKindRumIssue未在任何 spec 中枚举化。均不改。feat(alert-rule): deliver related query failures as an On-call label(509c61f)改的是告警事件 label 投递,非公开 API。/rum/data/query的x-mint.content本轮未改:已有 open PR docs(api-reference): daily api-review 2026-10-28 — RUM DQL parse errors are InvalidParameter #1144 正在改同一物理行(DQL 解析错误码InternalError→InvalidParameter),双方若都改该单行 JSON 字符串必然文本冲突;因此cumulative与 exact 槽位的说明放在 schema 属性描述里,等 docs(api-reference): daily api-review 2026-10-28 — RUM DQL parse errors are InvalidParameter #1144 合入后再考虑进 Usage 列表。本轮变更牵动的 api-reference 之外的文档面(未修,建议另开一轮跟进)
源码侧 PR #3408 撤掉的不只是响应字段,而是整个「License 释放配额」机制(
git grep 'ReleaseLicenses\|LicenseReleaseLimited\|license_release' origin/main已 0 命中,logic/resource/usage.go删掉了keyLicenseReleaseByWindow与cacheReleaseLicenses脚本,structs/metric.go删掉LicenseReleaseLimitedCount)。因此下列非 api-reference 页面也已过期,本轮按 api-review 的 surface 边界未动:en/developer/cli.mdx:504、zh/developer/cli.mdx:504(release_limited字段说明)en/developer/cli.mdx:963、zh/developer/cli.mdx:952(把release_limited当作「列表响应额外字段」的示例)en/platform/team-members.mdx:129、zh/platform/team-members.mdx:127与:130(删除成员不受释放配额约束的说明)en/platform/pricing.mdx:146、zh/platform/pricing.mdx:352(每个计费周期释放次数上限)已知窗口外遗留(未修,供人裁决)
RumDataQueryDefinition缺disable_cache:fc-rum4e883e9(2026-10-26T04:41Z)已在cmd/server/controller/data/types.go给query加了该字段(JSON 名disable_cache),2026-10-26 那轮未跟上,属窗口外历史遗留。校验
api-reference/*.json全部json.load通过(12 个 spec +openapi.legacy.zh.json)。python3 scripts/lint_openapi.py→OK: 12 spec files, no violations,exit 0。python3 scripts/api_path_redirects.py --check→ exit 0。mint broken-links:本环境未安装 mint,且本轮只改既有路径的 schema 与示例,不产生新链接。