[5/N] [List API] docs(service): document gateway List API#306
Open
albertywu wants to merge 1 commit into
Open
Conversation
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:
`make fmt`
STDOUT proof:
```
Formatting complete!
```
`make local-submitqueue-start`
STDOUT proof excerpt:
```
✅ Full stack is running!
Gateway gRPC: localhost:64687
Orchestrator gRPC: localhost:64686
```
`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 proof:
```json
{
"sqid": "test-queue/1"
}
```
`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 proof:
```json
{
"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
}
]
}
```
`make local-stop`
STDOUT proof:
```
Services stopped. Data volumes preserved.
```
This was referenced Jul 7, 2026
albertywu
requested review from
a team,
behinddwalls and
sbalabanov
as code owners
albertywu
changed the title
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
1 participant
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 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
STDOUT:
{ "sqid": "test-queue/1" }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 } ] }Stack