docs(buglog): follow-ups fixed (bug-1958..bug-1966); log bug-1967 (limit config re-push)

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Rongsong Shen 2026-10-10 10:47:23 +00:00
parent f389845701
commit f51adebe8e
Signed by untrusted user: rshen
GPG key ID: 80533536B0EB651C
11 changed files with 251 additions and 117 deletions

View file

@ -1,8 +1,8 @@
---
id: "bug-1966"
status: "open"
status: "fixed"
status_updated: "2026-10-10"
status_note: "newly logged"
status_note: ""
component: "apiserver"
severity: "noise"
timestamp: "2026-10-10T10:16:16Z"
@ -11,6 +11,7 @@ occurrences: 1
files: ["src/frontend/apiserver/controllers/hosts.go", "src/frontend/apiserver/docs/swagger.yaml"]
tags: ["apiserver", "docs", "swagger"]
related: []
fix_commits: ["f7fef278"]
gitea_issue: 397
gitea_synced_status: "open"
gitea_synced_hash: "d98430bca460"
@ -38,15 +39,16 @@ gitea_synced_hash: "d98430bca460"
- Frequency: deterministic (by code reading; confirmed by the RED test of the fix)
- Evidence: the code sites quoted in Description; no logs kept.
## Root cause
TODO: required for fixed/partial
Swag annotations in `controllers/hosts.go` and `controllers/jobs.go` named non-existent types (`models.Error`, `ErrorResponse`, `JobsResponse`, `JobSignalRequest`, `JobControlResponseSummary`), had malformed `@Param`/`@Failure` lines and wrong `/api/v1` paths, and no general API info existed. Pre-existing.
## Fix
TODO: required for fixed/partial
Errors use `JsonErrStruct` (what `ReturnError` writes), success `JsonStruct`; bodies use `models.JobSubmitRequest`, `JobControlJobIDRequest`, `JobControlRequest`; paths match the routes; `@BasePath /xce/v1` and general info in `cmd/main.go`; `docs/docs.go`, `swagger.json`, `swagger.yaml` regenerated with `swag init -g cmd/main.go -o docs`. Only hosts and jobs handlers are annotated so far.
## Verification
- Test: TODO: name + file; RED before the fix, GREEN after
- Suites: TODO: suite results and build profile
- Live: TODO: soak/deploy run, or n/a and why
- Test: RED: `swag init -g cmd/main.go` failed with `ParseComment error in file .../controllers/hosts.go ... models.Error: cannot find type definition`; GREEN: swag runs cleanly and the spec lists `/hosts`, `/jobs`, `/jobs/create`, `/jobs/{jobids}`, `/jobs/{jobids}/control`, `/jobs/control`; `cmd` (imports docs) tests pass.
- Suites: `xce-build.sh all asan xce.build --incremental` on the merged branch, 2026-10-10: C suites Ok 157 / Fail 0; frontend Go tests ok (the build now also runs apiserver cmd, middleware, models and router)
- Live: n/a: unit/fixture-level verification; no live deployment was run
## References
- Related: none
- Fix commits: `f7fef278` (on `scheduler-framework`)
- Found as a follow-up of the 2026-10-10 P0 fixes (bug-1936..1957)