Skip to content

docs: add gateway list api rfc#225

Open
albertywu wants to merge 3 commits into
mainfrom
wua/list-api-rfc
Open

docs: add gateway list api rfc#225
albertywu wants to merge 3 commits 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).

Test Plan

Issues

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.

Detailed logs may have a separate policy later only if the UX no longer needs
timeline/debug information for the same period.

## Flow

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

we need to add sorting as well? generally FIFO/time-based would be fine..but often we need to know or say what at the head of the queue and time-based listing may not reflect that clearly?

@albertywu albertywu Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added a Sorting section above and how it would work. To start, we'd support sorting by admitted asc / dsc and later when BE supports queue-positioning info we can also add support for that.

@albertywu albertywu requested a review from behinddwalls June 16, 2026 21:35
@albertywu albertywu marked this pull request as ready for review June 16, 2026 21:39
Copilot AI review requested due to automatic review settings June 16, 2026 21:39
@albertywu albertywu requested review from a team and sbalabanov as code owners June 16, 2026 21:39

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread doc/rfc/submitqueue/list-api.md
Comment thread doc/rfc/submitqueue/list-api.md
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.

4 participants