Skip to content

docs(middleware): document response pre-return workflow - #3075

Draft
pimlock wants to merge 2 commits into
2691-http-response-runtime/pimlockfrom
2691-http-response-docs/pimlock
Draft

docs(middleware): document response pre-return workflow#3075
pimlock wants to merge 2 commits into
2691-http-response-runtime/pimlockfrom
2691-http-response-docs/pimlock

Conversation

@pimlock

@pimlock pimlock commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Document the HTTP response pre-return contract and reorganize the supervisor middleware guide around request, response, and WebSocket runtime flows. Keep the gateway configuration page focused on the TOML surface and delegate detailed middleware behavior to the middleware guide.

Stacked on #3074, which implements the response runtime and relay integration. The lower stack layers are #3073 for the interface and #3072 for shared header mutation authority.

Related Issue

Closes #2691

Changes

  • document response preflight, headers-only, whole-body, streaming, trailers, framing repair, and failure semantics
  • group the middleware guide into runtime flow, configuration, and operations sections
  • document request, response, and trailer header authority with the shared validator model
  • point the guide at the existing content-guard example
  • reduce the gateway configuration section to the TOML fields and delegate contract details to the middleware guide
  • reconcile policy, architecture, RFC, authentication, and protocol-extension references

Testing

  • mise run pre-commit

Checklist

  • Published documentation describes the user-visible behavior
  • Gateway configuration retains the complete field surface without duplicating the middleware guide
  • RFC and architecture references match the implemented contract
  • Commit is signed off for DCO

Stack

  1. feat(middleware): broaden HTTP header mutation authority #3072 — shared header mutation authority
  2. feat(middleware): define HTTP response pre-return interface #3073 — response protobuf and transport interface
  3. feat(network): inspect HTTP responses before return #3074 — response runtime, relay integration, and existing example
  4. docs(middleware): document response pre-return workflow #3075 — documentation and middleware guide reorganization

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

@copy-pr-bot

copy-pr-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
@pimlock
pimlock force-pushed the 2691-http-response-docs/pimlock branch from 1bc705a to 433af64 Compare September 1, 2026 06:49
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