Skip to content

docs: add gateway list api rfc#225

Draft
albertywu wants to merge 1 commit into
mainfrom
wua/list-api-rfc
Draft

docs: add gateway list api rfc#225
albertywu wants to merge 1 commit into
mainfrom
wua/list-api-rfc

Conversation

@albertywu

@albertywu albertywu commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

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).

Stack

  1. @ docs: add gateway list api rfc #225
  2. feat(gateway): add List API with request-summary read model #226

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 List API 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.

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.

3 participants