Skip to content

Commit b28fd3e

Browse files
committed
docs(middleware): define stage-local response body modes
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
1 parent 02f3984 commit b28fd3e

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

proto/supervisor_middleware.proto

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,16 @@ message HttpResponsePreflight {
176176
// whole-body input/replacement and each stream replacement. Stream inputs use
177177
// at most half this limit.
178178
uint64 max_payload_bytes = 7;
179-
// Modes computed once from the original response head. HEADERS_ONLY is always
180-
// present and is the only mode for bodyless, partial, encoded, or no-transform
181-
// responses. Oversized or open-ended responses omit WHOLE_BODY_BYTES.
182-
// Selecting an unlisted mode fails according to on_error.
179+
// Modes derived independently for this stage. OpenShell first determines
180+
// response-shape eligibility from the original final response head, then
181+
// applies this stage's effective max_payload_bytes. Different stages may
182+
// receive different lists. HEADERS_ONLY is always present and is the only
183+
// mode for bodyless, partial, encoded, or no-transform responses. For an
184+
// otherwise eligible response, a known body larger than this stage's limit
185+
// omits WHOLE_BODY_BYTES. An eligible unknown-length response may select
186+
// WHOLE_BODY_BYTES and later fail with whole_body_over_capacity according to
187+
// this stage's on_error. Selecting an unlisted mode fails according to
188+
// on_error.
183189
repeated HttpResponseBodyMode permitted_body_modes = 8;
184190
// Allows STREAM_BYTES replacements to defer bytes across units. Set only for
185191
// fail-closed stages; fail-open stages cannot defer.

0 commit comments

Comments
 (0)