ENGINEERING

Detect live API drift from the published OpenAPI contract on a schedule

On a daily schedule, fetch the running API's live OpenAPI document and compare it to the source-of-truth spec in your repo; if the deployed surface has drifted, open a GitHub…

CategoryEngineering
Enginesim
Difficultyadvanced
Triggerschedule
Steps6
Setup~25 min

How it runs

The automated pipeline, trigger to output.

  • TriggerDaily schedule fires
  • ActionFetch live OpenAPI document from running serviceHTTP webhook
  • ActionRead canonical spec from repositoryGitHubGitHub
  • LogicDiff live vs canonical; stop if no drift
  • ActionOpen GitHub issue describing the driftGitHubGitHub
  • OutputPage API on-call via PagerDutyPagerDutyPagerDuty

What it does

Periodically pulls the OpenAPI document served by your live API and diffs it against the canonical spec committed in your repository. Any divergence (an endpoint live but undocumented, a field removed in production but still in the spec, a changed type) is flagged as drift.

When to use it

Use it when your published contract and your running service can fall out of sync because deploys outpace doc updates. It catches the dangerous gap where consumers trust a spec that no longer matches production behavior.

How it works

  1. 1A scheduled trigger runs the check on your chosen cadence (e.g. daily).
  2. 2An HTTP request fetches the live OpenAPI document from the running service.
  3. 3The flow reads the canonical spec from the GitHub repository.
  4. 4A diff step compares live versus canonical and isolates drift items.
  5. 5A logic branch exits quietly if there is no drift; otherwise it continues.
  6. 6It opens a GitHub issue detailing each drift and triggers a PagerDuty alert for the API on-call.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect HTTP webhookTrigger any URL on agent actions.
  2. 2
    Connect GitHubRepos, issues, pull requests, actions.
  3. 3
    Connect PagerDutyIncidents, on-call, escalations.
  4. 4
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  5. 5
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  6. 6
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.