Skip to content

README: match the code - #53

Open
markmnl wants to merge 1 commit into
mainfrom
readme-match-code
Open

markmnl wants to merge 1 commit into
mainfrom
readme-match-code

Conversation

@markmnl

@markmnl markmnl commented Oct 17, 2026

Copy link
Copy Markdown
Owner

Brings README.md in line with the handlers. Each item was checked against the code on main; no code changes.

Section README said Code does
GET /fmsg/:id example common_type field No such field in models.Message; example also lacked sha256/psha256 and showed has_add_to: false with an add_to batch
Empty arrays attachments: [] to, to_delivery, add_to, attachments are null when empty; only reactions is set to []
POST /fmsg version, type, size required Only from + non-empty to; type/version checked at send; size ignored (stored size is len(data))
Send gate note create/update accept drafts with no recipients Create rejects an empty to; update accepts it
PUT /fmsg/:id "same body as POST", no response to may be empty; 200 {"id"}
413s not listed for create, update, attach FMSG_API_MAX_DATA_SIZE, FMSG_API_MAX_ATTACH_SIZE, FMSG_API_MAX_MSG_SIZE
thread/messages — 500 thread_data_unavailable when a body can't be read
Sub-accounts allowed_cidrs not marked required At least one CIDR on create and PATCH (ValidateCIDRs)
rotate-key no response shape agent, addr, grant_type, key_id, key_expires_at, api_key
limit 1–100 Values above 100 return 100

go build ./... passes.

🤖 Generated with Claude Code

- GET /fmsg/:id example: drop common_type (never returned), add sha256 and
  psha256 (and a batch's sha256), and has_add_to true to match its add_to;
  to, to_delivery, add_to and attachments are null when empty.
- POST /fmsg: only from and a non-empty to are required; type and version are
  checked at send, size is ignored (the stored size is len(data)); 413.
- PUT /fmsg/:id: to may be empty; 200 {"id"}; 413s.
- Send gate: create still needs recipients; update doesn't.
- POST /fmsg/:id/attach: 413s.
- GET /fmsg/:id/thread/messages: 500 thread_data_unavailable.
- Sub-accounts: allowed_cidrs needs at least one range (create and PATCH);
  rotate-key's response.
- limit above 100 returns 100 rather than being rejected.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant