Skip to content

[6/N] [List API] docs(service): document gateway List API read model#306

Open
albertywu wants to merge 1 commit into
wua/list-api-e2efrom
wua/list-api-service-readme
Open

[6/N] [List API] docs(service): document gateway List API read model#306
albertywu wants to merge 1 commit into
wua/list-api-e2efrom
wua/list-api-service-readme

Conversation

@albertywu

@albertywu albertywu commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the SubmitQueue Gateway List API to the service README API reference and includes a grpcurl example for listing recent requests by queue and time window.

Test Plan

  1. Start up server, issue a Land Request using:
grpcurl -plaintext -import-path . -proto api/submitqueue/gateway/proto/gateway.proto -d '{"queue":"test-queue","change":{"uris":["github://uber/docs-list/pull/2/abcdef0123456789abcdef0123456789abcdef02"]},"strategy":"REBASE"}' localhost:64687 uber.submitqueue.gateway.SubmitQueueGateway/Land

STDOUT:

{
  "sqid": "test-queue/1"
}
  1. Issue a List API request:
grpcurl -plaintext -import-path . -proto api/submitqueue/gateway/proto/gateway.proto -d '{"queue":"test-queue","start_time_ms":1,"end_time_ms":9999999999999,"page_size":10}' localhost:64687 uber.submitqueue.gateway.SubmitQueueGateway/List

STDOUT:

{
  "requests": [
    {
      "sqid": "test-queue/1",
      "queue": "test-queue",
      "changeUris": [
        "github://uber/docs-list/pull/2/abcdef0123456789abcdef0123456789abcdef02"
      ],
      "status": "landed",
      "metadata": {
        "batch_id": "test-queue/batch/1"
      },
      "startedAtMs": "1783389642136",
      "updatedAtMs": "1783389644505",
      "completedAtMs": "1783389644505",
      "terminal": true
    }
  ]
}

Issues

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

@albertywu albertywu marked this pull request as ready for review July 7, 2026 02:11
@albertywu albertywu requested review from a team, behinddwalls and sbalabanov as code owners July 7, 2026 02:11
@albertywu albertywu changed the title docs(service): document gateway List API [5/N] [List API] docs(service): document gateway List API Jul 7, 2026
@albertywu albertywu force-pushed the wua/list-api-service-readme branch from 1e1ef36 to 547fc3d Compare July 7, 2026 22:29
@albertywu albertywu changed the title [5/N] [List API] docs(service): document gateway List API [6/N] [List API] docs(service): document gateway List API read model Jul 7, 2026
@albertywu albertywu force-pushed the wua/list-api-service-readme branch from 547fc3d to 0634eb1 Compare July 7, 2026 22:40
@albertywu albertywu force-pushed the wua/list-api-service-readme branch from 0634eb1 to abc901e Compare July 8, 2026 00:15
@albertywu albertywu force-pushed the wua/list-api-service-readme branch from abc901e to 3304589 Compare July 8, 2026 00:19
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