Monthly scan that finds every endpoint, field, and header marked deprecated in the API surface, reads the recorded sunset date, and classifies each item as past sunset, approaching sunset, or missing a sunset date. For items past sunset it checks for remaining traffic and call sites, then returns a structured removal report so a downstream ticket can be filed.
- Identifier
api-deprecation-sweep- Version
- 1.0.2
- Steps
- 4
- Triggers
- 1
- api
- deprecation
- openapi
- maintenance
- scheduled
- automated
When it runs
schedule.monthly- Schedule
- Day 1 of each month at 05:00 UTC
0 5 1 * * - Timezone
- UTC
The pipeline
The graph below is the one the workflow opens with in the builder — same steps, same layout, drawn on the same canvas. The run playing through it is a simulation; the branches and conditions are real.
- 01Monthly Schedule (1st 05:00 UTC)
triggerThe event that starts the run.
- 02Clone Repository ⚠️ SET YOUR REPO
git.cloneShallow-clones the repository at the right ref.
- 03Scan API Deprecations
agent.runOne agent works the task with its toolkit.
- 04File Removal Ticket
ticket.createOpens a ticket on the connected tracker.
The agent
API Deprecation Analyst
- Base type
- Senior Developer
- Temperature
- 0.2
- Max iterations
- 40
- Tools
- 4
Filesystem · 1
read_fileRead File · read
Code search · 1
code_searchCode Search · read
Tickets · 1
create_ticketCreate Ticket · write
Status · 1
update_statusUpdate Status · write
Related playbooks
Stale PR Reaper
Daily sweep that nudges pull requests that have gone quiet before they rot.
API Contract Breaking-Change Detector
Detects breaking changes in published API contracts, names affected consumers, and labels the PR.
OpenAPI Drift Check
Regenerates the OpenAPI spec from decorators on controller/DTO PRs and classifies every diff as additive, breaking, or docs-only.