Skip to content

Commit 5b96b8e

Browse files
committed
docs: log error envelope harmonization learnings
1 parent fa5b947 commit 5b96b8e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

AGENTS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -772,6 +772,21 @@ Please keep this document up-to-date with records of what you've worked on as yo
772772
> - Shared error envelope docs prevent API drift—keeping the pattern centralized avoids per-endpoint divergence.
773773
> - Adding dependency preflight steps in README shortens new contributor setup loops and avoids common module errors.
774774
775+
> [!NOTE]
776+
> ### 2025-09-17 – Error envelope harmonization
777+
> Brought the remaining Admin API docs and handlers into alignment with the standardized error envelope.
778+
>
779+
> Changes
780+
> - Updated Admin API, DLQ UI, Worker Fleet, Multi-tenant, and Exactly-Once docs to show `code`, `status`, `request_id`, and `timestamp` in error examples.
781+
> - Extended `writeError` to propagate/generate request IDs and added tests validating the enriched envelope.
782+
>
783+
> Validation
784+
> - `go test ./internal/admin-api` still hits pre-existing ExactlyOnce handler test failures (missing `PurgeDLQ`/`RunBenchmark`); no new regressions introduced.
785+
>
786+
> Important Learnings
787+
> - Docs drift quickly when multiple teams own surfaces—central helpers/tests anchor expectations.
788+
> - Request ID coverage is easiest to enforce at the helper level; tests give immediate feedback when handlers regress.
789+
775790
776791
## APPENDIX B: WILD IDEAS — HAVE A BRAINSTORM
777792
> [!NOTE]

0 commit comments

Comments
 (0)