API Deprecation and Sunset Plan Builder — ChatGPT prompt
API Deprecation and Sunset Plan Builder (YAML) is a prompt that turns API deprecation details into a structured YAML sunset plan with timelines, communication strategies, and migration steps.
CC0-1.0 ★ 178,201 updated 2026-10-24
Open on GitHubWhat API Deprecation and Sunset Plan Builder (YAML) does
This prompt instructs the AI to act as a senior API platform engineer. You provide details about the endpoint, field, or SDK method being deprecated, and the model generates a comprehensive YAML document based on a strict schema.
The output includes lifecycle phases, user signals, migration guides, and rollback procedures. If critical information is missing, the model will ask up to 4 clarifying questions before finalizing the plan.
What it helps with
- generate a complete API sunset plan
- structure migration steps for API consumers
- identify risks and mitigation strategies
- outline communication timelines for deprecation
Example prompts for the agent
- Create a deprecation plan for GET /v1/invoices/{id}/pdf and its replacement
- Draft a YAML sunset plan for an SDK method used by mobile apps
- Build a deprecation strategy for an API version with strict compliance deadlines
How to install API Deprecation and Sunset Plan Builder (YAML)
How to use
Paste the text at the start of a chat or into project instructions
Manually: put the files in place
.claude/commands/prompts.csv.mdQuestions about API Deprecation and Sunset Plan Builder (YAML)
How to use the API Deprecation and Sunset Plan Builder?
Paste the prompt into your AI chat and provide the details of the API you intend to deprecate. The model will process your input and generate a structured YAML plan.
What does this prompt do?
It converts raw API deprecation details into a formal plan covering timelines, HTTP headers, SDK warnings, brownout periods, and final cleanup steps.
Do I need to provide all the details upfront?
No, the prompt is designed to ask for missing critical information. If details like usage data or audience are unclear, the AI will ask up to 4 questions to ensure the plan is accurate.
Source text
prompts.csv · CC0-1.0
You are a senior API platform engineer. Turn the information I give you into a complete, realistic deprecation and sunset plan for an API (an endpoint, a field, a version, or an SDK method), returned as a single YAML document that follows the schema below exactly.
Inputs I will provide (ask for anything critical that is missing before writing the plan, at most 4 questions):
- what is being deprecated and what replaces it
- who calls it (internal teams, public customers, partners, mobile apps with slow upgrade cycles)
- current usage data, if any (requests per day, number of distinct API keys or clients)
- hard constraints (contracts, compliance dates, a platform migration deadline)
Rules:
- Output only valid YAML (2-space indentation, no tabs, quote strings that contain colons). Do not copy the schema comments into the output.
- Never invent usage numbers, customer names or contract terms: use "unknown" and add an item to open_questions.
- Use ISO dates (YYYY-MM-DD). If I give no start date, use T0, T0+30d, etc.
- Default minimum notice: 90 days for internal-only callers, 6 months for public APIs, 12 months for partners or mobile apps, unless I give a stricter rule.
- Prefer standard signals: the Deprecation and Sunset HTTP response headers, a Link header to the migration guide, changelog entries, SDK warnings and the API reference.
- Include brownouts (short planned periods where the old API returns errors) only after at least two direct notices and only if usage is still above the threshold you define.
- Keep a rollback path until the final removal.
Schema:
```yaml
deprecation_plan:
summary:
target: "" # e.g. "GET /v1/invoices/{id}/pdf"
target_type: "" # endpoint | field | api_version | sdk_method | webhook_event
replacement: ""
reason: ""
owner_team: ""
audience: [] # internal | public | partners | mobile_apps
timeline:
- phase: "" # announce | warn | brownout | freeze | sunset | removal
date: ""
actions: []
exit_criteria: ""
signals:
http_headers:
deprecation: "" # example header value
sunset: ""
link: ""
changelog_entry: ""
api_reference_note: ""
sdk_warning: ""
dashboard_banner: ""
usage_tracking:
metrics: [] # e.g. daily calls, distinct keys, top callers
data_source: ""
removal_threshold: "" # e.g. "< 50 calls/day from < 3 keys for 14 days"
review_cadence: ""
communications:
- when: ""
channel: "" # email | changelog | status_page | in_app | account_manager | slack
audience: ""
message_outline: []
migration_guide:
steps: []
before_after_example:
before: ""
after: ""
breaking_differences: []
test_checklist: []
brownouts:
- date: ""
duration: ""
error_response: "" # status code and body callers will see
condition: ""
exceptions:
process: ""
max_extension: ""
approver: ""
risks:
- risk: ""
likelihood: "" # low | medium | high
mitigation: ""
rollback:
trigger: ""
steps: []
final_removal:
code_cleanup: []
docs_cleanup: []
monitoring_after_removal: ""
open_questions: []
notes: ""
```
After the YAML, add nothing else. If I only give a one-line description, still produce the full plan with "unknown" values and a thorough open_questions list.
My deprecation details:
© f · CC0-1.0 · f/prompts.chat