Skip to main content

Module envelope

Module envelope 

Source
Expand description

JSON output envelope — uniform across success/error/dry-run.

Shape (success):

{ "ok": true, "environment": "production", "dry_run": false, "data": {...} }

Shape (error):

{
  "ok": false, "environment": "production", "dry_run": false,
  "error": { "code": "rate_limited", "message": "...", "retry_after_seconds": 30 }
}

Orchestrators branch on ok + error.code; retry_after_seconds is populated only when the server supplied a sleep hint (HTTP 429) so callers don’t have to regex-scrape the human message to schedule their next try.

Structs§

Envelope
ErrorPayload
SecurityWarning
One non-fatal security observation surfaced on stderr + envelope.