docs: add gateway list api rfc#225
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an RFC documenting the intended design and semantics of a queue-scoped gateway List API (to complement the existing per-sqid Status RPC), including time-window overlap behavior, status filtering, read-model requirements, pagination, and retention. This RFC aligns with the stacked implementation work described in PR #226 by capturing the gateway-owned read model approach and ownership boundaries.
Changes:
- Introduces an RFC describing the
ListAPI shape (inputs/outputs) and request-summary fields. - Specifies lifecycle-overlap time-window semantics, current-status (non-historical) behavior, and status-filter validation expectations.
- Documents read-model, pagination (opaque cursor), and retention considerations plus an end-to-end flow diagram.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JamyDev
approved these changes
Jun 9, 2026
albertywu
force-pushed
the
wua/list-api-rfc
branch
from
f5c76ca to
0096a76
Compare
behinddwalls
approved these changes
Jun 18, 2026
behinddwalls
temporarily deployed
to
stack-rebase
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds gateway List API rfc
Main idea here is the storage for list api is colocated / materialized at the same time request logs are upserted and the list api results should match up with what the status endpoint returns (both Status and List data is derived from immutable request logs stream and data is stored in gateway layer, not orchestrator).
Test Plan
Issues
Stack