Skip to main content

Module response

Module response 

Source
Expand description

Typed, framework-neutral REST response envelopes. Typed REST envelopes. Products own codes, messages, HTTP behavior and diagnostic policy.

Structs§

ApiEmptyData
Empty JSON object used for data: {}, distinct from omitted data or JSON null.
ApiErrorInfo
Product-neutral error metadata with a typed product diagnostic extension. Products decide retryability, diagnostic visibility, classification and redaction.
ApiResponse
REST wire contract: {code,msg,data?,error?}.

Enums§

ResponseEnvelopeError
Invalid envelope state, independent of product-facing errors and HTTP status.

Traits§

ApiResponseCode
Product-provided classification of a serialized code. Forge supplies no business codes.