Skip to content

[1/N] [List API] docs(list): define request context read model#310

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

[1/N] [List API] docs(list): define request context read model#310
albertywu wants to merge 1 commit into
mainfrom
wua/list-api-rfc-design

Conversation

@albertywu

@albertywu albertywu commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates List API RFC with:

  • Proto contract
  • RequestContext, an immutable data store that captures request context like queue & changeIDs. Data here is projected onto RequestSummary at write time.
  • Changed List time-window semantics from lifecycle overlap to requests admitted during [start_time_ms, end_time_ms). Doing lifecycle-overlap queries as previously specified requires a lot of additional complexity to make performant, so is deferred.

Stack

  1. @ [1/N] [List API] docs(list): define request context read model #310
  2. [2/N] [List API] feat(context): add immutable request admission store #302
  3. [3/N] [List API] feat(summary): project request logs from admission context #303
  4. [4/N] [List API] feat(gateway): expose List API from request summaries #304
  5. [5/N] [List API] test(e2e): cover gateway List API #305
  6. [6/N] [List API] docs(service): document gateway List API read model #306

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

This PR updates the SubmitQueue Gateway List API RFC to more explicitly define the gateway-owned read model, including an immutable request-admission context record that can be joined with append-only request-log events to project a queryable request-summary table for the List RPC.

Changes:

  • Expands the RFC’s proposed wire contract (proto sketch) for List, including request/response messages and sorting options.
  • Introduces and motivates an immutable RequestContext admission record as the source of truth for queue + change URIs + admission time.
  • Refines the read-model projection/pagination/indexing discussion (idempotent projection, lifecycle-overlap semantics, keyset pagination).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread doc/rfc/submitqueue/list-api.md Outdated
Comment thread doc/rfc/submitqueue/list-api.md Outdated
Comment thread doc/rfc/submitqueue/list-api.md Outdated
Comment thread doc/rfc/submitqueue/list-api.md
Comment thread doc/rfc/submitqueue/list-api.md
@albertywu albertywu force-pushed the wua/list-api-rfc-design branch from 7cd8e9a to ec3d5ec Compare July 7, 2026 22:40
Copilot AI review requested due to automatic review settings July 8, 2026 00:15
@albertywu albertywu force-pushed the wua/list-api-rfc-design branch from ec3d5ec to 45a3b43 Compare July 8, 2026 00:15

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 1 comment.

Comments suppressed due to low confidence (1)

doc/rfc/submitqueue/list-api.md:254

  • The RFC ends with a ## Why Not Return Timelines header but no content. This reads like an incomplete section and can confuse readers; either remove the header or add the intended rationale text.
## Why Not Return Timelines

Comment thread doc/rfc/submitqueue/list-api.md
@albertywu albertywu force-pushed the wua/list-api-rfc-design branch from 45a3b43 to 476f776 Compare July 8, 2026 00:18
@albertywu albertywu marked this pull request as ready for review July 8, 2026 00:22
Copilot AI review requested due to automatic review settings July 8, 2026 00:22
@albertywu albertywu requested review from a team, behinddwalls and sbalabanov as code owners July 8, 2026 00:22

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 no new comments.

Comments suppressed due to low confidence (1)

doc/rfc/submitqueue/list-api.md:256

  • The RFC ends with a "## Why Not Return Timelines" heading but no body text, which leaves the rationale incomplete and reads like an accidental truncation.
## Why Not Return Timelines

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.

2 participants