Updates to the documentation.

Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
Scott Idem
2026-04-30 17:13:11 -04:00
parent a1ebeddf9d
commit e7b6045580
2 changed files with 24 additions and 0 deletions

View File

@@ -296,6 +296,14 @@ These are real incidents — know them before you start.
valid account-scoped requests to lose account context and 403. `key` can be a valid
endpoint/business param, but it is not equivalent to `x-no-account-id: bypass`.
11. **Pre-stringifying `*_json` fields before passing to API wrappers** — the API wrappers
(`api_post__crud_obj.ts` for V3, `api.ts` for legacy CRUD) automatically serialize any
field ending in `_json` (e.g. `cfg_json`, `data_json`). Pass these as plain JS objects.
Pre-stringifying with `JSON.stringify()` before calling the wrapper will double-encode
the value in the legacy path (stringify sees a string and escapes it), and is at best
redundant on the V3 path. Both paths now pretty-print with 2-space indent.
See `GUIDE__AE_API_V3_for_Frontend.md` → section 3C for the full explanation.
---
## 8. Source Layout (Quick Reference)