sdk: add webhookHealthy to SyncProviderStatus#81
Merged
khaliqgant merged 1 commit intomainfrom May 5, 2026
Merged
Conversation
Productized cloud-mount contract §7.4 mandates that the cloud `/sync` response surfaces a per-provider `webhookHealthy` boolean so consumers can render the "falling back to periodic sync" warning when webhook delivery is degraded. The cloud platform already populates the field in its provider-status summarizer (cloud#406); the relayfile CLI already renders the warning row when the field is false (relayfile#71). The TypeScript SDK type did not declare it, forcing both consumers to read it via permissive casts. Add it as an optional field on `SyncProviderStatus` in both the TS and Python SDK types so consumers can drop the cast. Non-breaking: the field is `?: boolean` (TS) / `bool | None = None` (Python). Older deployments that do not yet emit the field still deserialize cleanly. The Python client returns raw `dict[str, Any]` for sync status so no parser update is needed; the type is documentation for consumers who construct SyncProviderStatus instances by hand.
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
webhookHealthy?: booleanfield toSyncProviderStatusin both the TypeScript and Python SDK types so cloud and relayfile-CLI consumers can drop their permissive-cast workarounds.Why
Productized cloud-mount contract §7.4 mandates that the cloud
/syncresponse surfaces a per-providerwebhookHealthyso the CLI can render the "falling back to periodic sync" warning when webhook delivery is degraded. The cloud already emits the field (cloud#406) and the relayfile CLI already consumes it (relayfile#71), but the SDK type didn't declare it — forcing both sides to read it via index-access casts.Compatibility
Non-breaking type-only change:
Older relayfile/cloud deployments that don't emit the field still deserialize cleanly.
Tests
Follow-up after merge
Test plan