Skip to content

chore: read progress present for all read operations #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmandaYao00 merged 1 commit into from
May 22, 2026
Merged

chore: read progress present for all read operations #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions api/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2216,7 +2216,7 @@ paths:
get:
summary: Get an operation
description: |
Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.
Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
operationId: getOperation
tags: ["Operation"]
parameters:
Expand All @@ -2236,7 +2236,7 @@ paths:
example: 3efc0f0f-4bb9-498f-996c-9893d98ca4b5
responses:
200:
description: The operation, including its current status, result summary, and metadata (e.g. backfill progress or write results).
description: The operation, including its current status, result summary, and metadata (e.g. read progress or write results).
content:
application/json:
schema:
Expand All @@ -2256,8 +2256,8 @@ paths:
metadata:
objects: [contact]
createTime: "2023-07-13T21:34:44.816354Z"
readBackfill:
summary: Read with backfill progress
readProgress:
summary: Read with progress
value:
projectId: "123e4567-e89b-12d3-a456-426614174000"
integrationId: "113e9685-9a51-42cc-8662-9d9725b17f14"
Expand Down Expand Up @@ -5620,7 +5620,7 @@ components:
example: "[contact] No new data found"
metadata:
type: object
description: Additional operation details (e.g. objects, retry info, backfill progress, successfulRecordIds).
description: Additional operation details (e.g. objects, retry info, read progress, successfulRecordIds).
properties:
objects:
type: array
Expand All @@ -5639,7 +5639,7 @@ components:
format: date-time
progress:
type: object
description: Only present for backfill read operations.
description: Read progress for the operation, reporting records processed and, where available, the estimated total. Present for all read operations.
properties:
installationId:
type: string
Expand Down
Loading
Loading