api-review: add RUM remote-config & schedule by-person APIs; member_id filter on /member/list - #344
Merged
Merged
Conversation
…r_id filter on /member/list
Registry drift vs committed specs (fc-pgy api_test.go lines 931, 1187-1191):
- POST /rum/application/remote-config/{get,update,preview,history/list,history/revert}
(fc-rum #204, registered 2026-08-31)
- POST /schedule/by-person (fc-oncall #266 aae1eab, registered 2026-09-01)
Schema drift: POST /member/list gains optional member_id (uint64) filter
(fc-pgy bb7f8e39).
Nav (docs.json) and api-catalog.mdx reconciled: On-call 192->193,
RUM 36->41, total 336->342. Split + consolidated specs updated in
EN and ZH; openapi.legacy.zh.json untouched.
Resolve conflicts with the AI SRE artifact gallery publish:
- consolidated openapi.{en,zh}.json: union of both additions
(artifact ops + RUM remote-config / schedule by-person / member_id)
- api-catalog: keep both sections; endpoint count 353
- fix lint: document RemoteConfig.activation enum value 'immediate'
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.
Summary
Daily api-review audit (
--mode generate --scope all --auto) comparing the fc-pgy public-API registry (logic/api/api_test.go@ 8aed5cb8, 953 rows / 342 auth=all) against the committed OpenAPI 3.1 specs, plus handler-drift scan of all backend repos since each spec file's last commit.Operation changes
RUM (
rum.openapi.*.json) — 5 added/rum/application/remote-config/getrum-application-remote-config-read-get/rum/application/remote-config/updaterum-application-remote-config-write-update/rum/application/remote-config/previewrum-application-remote-config-read-preview/rum/application/remote-config/history/listrum-application-remote-config-read-history-list/rum/application/remote-config/history/revertrum-application-remote-config-write-history-revertOn-call (
on-call.openapi.*.json) — 1 added/schedule/by-personscheduleByPersonPlatform (
platform.openapi.*.json) — 1 updated, 0 addedPOST /member/list:MemberListRequestgains optionalmember_id(integer, uint64) filter — fc-pgy bb7f8e39 ("Add member_id filter to POST /member/list").Removed / other updates
None. Handler-drift scan found no other schema-affecting changes (fc-event WeCom commits are template-engine internals; fc-rum session commits touch engine ingestion only; fc-datasource commits are IM send-logic only; fc-safari types changed no field used by public schemas; fc-statuspage had no commits since last spec update).
Schemas added
RemoteConfig,RemoteConfigValues,RemoteConfigRule,RemoteConfigHistoryItem+ 5 request/response pairs.ScheduleByPersonRequest,ScheduleByPersonResponse,MemberOncallInterval,MemberScheduleItem.Constraints provenance
Only Go
binding:tags and explicit handler/model code were used:application_idrequired;reasonmax=255;versionrequired min=1 (revert);pmin=0 max=100000;limitdefault 20 / max 100 (handler clamp);orderbyenumupdated_at|version(SanitizeOrderBy allowlist); rules maxItems 20 (MaxRemoteConfigRules);matchminProperties 1 + value maxLength 256 (Validate); rates min 0 max 100 (validateRate);defaultPrivacyLevel/activationenums (validPrivacyLevels/validRemoteConfigActivations);customlimits (validateCustom).updated_atfields carry "Unix timestamp in milliseconds" (getOutput doc comment; modelUnixMilli()); schedulestart_at/end_atcarry "Unix timestamp in seconds".Unresolved
0 — every new registry row resolved to a handler. Note:
monit-webapi/monit-edgeare not on GitHub, so the Monitors module was covered by registry comparison only (no handler-drift scan), per standing practice its committed content is preserved.Examples
All request/response examples are constructed from the schemas (realistic IDs reused from sibling examples:
WoyQQ3BohkdtPivubEvE8o,2539108069860,01HK8XQE3Z7JM2NTFQ5YJ8P9R4); no dev-API captures were performed in this environment.Reconciliation
docs.json: +1 page (Schedules), +5 pages (Applications), both languages.api-catalog.mdx(en+zh): +6 rows; On-call 192→193, RUM 36→41, total 336→342.Verification
docs.jsonand bothapi-catalog.mdxfiles.