Skip to content

feat(directory-sync): support on-demand directory syncing - #560

Draft
katie-west wants to merge 1 commit into
mainfrom
katie/feat-3084-directory-sync-api
Draft

katie-west wants to merge 1 commit into
mainfrom
katie/feat-3084-directory-sync-api

Conversation

@katie-west

Copy link
Copy Markdown

Why

I regenerated Directory Sync from the manual-sync API spec so applications can request an on-demand pull without using the Dashboard.

  • The provider-neutral sync action posts to /directories/{id}/sync and returns the typed queued response.
  • Existing SDK request/error handling applies to unsupported directories, in-progress syncs, cooldowns, and temporarily paused syncing.
  • Initial API support is Google Workspace. A queued result is acceptance for asynchronous processing, not confirmation of completion.

Not covered by CI

  • Coordinate release with deployment of the public API endpoint; do not publish the method as available before the route is deployed.
  • Verify a configured Google Workspace directory against the deployed endpoint, including the shared five-minute cooldown and subsequent completed pull.

Proof

No live provider-sync evidence captured. Before release, verify a 202 queued response and a repeated request's conflict or rate-limit outcome, then confirm the requested pull completes. Generated changes come from the OpenAPI spec and DirectorySync naming policy, not hand-edited generated methods.

Fixes FEAT-3084

@katie-west katie-west added the autogenerated Autogenerated code or content label Sep 25, 2026
@linear-code

linear-code Bot commented Sep 25, 2026

Copy link
Copy Markdown

FEAT-3084

@katie-west

Copy link
Copy Markdown
Author

Coordinated draft set: API/docs https://github.com/workos/workos/pull/74202 and SDK generation policy workos/openapi-spec#193. Keep releases after the API deployment. The API draft contains the full companion list; no SDK packages have been published.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autogenerated Autogenerated code or content

Development

Successfully merging this pull request may close these issues.

1 participant