API Deprecation and Sunset Plan Builder — промпт для ChatGPT
Промпт API Deprecation and Sunset Plan Builder (YAML) превращает описание устаревающего API в YAML-план вывода из эксплуатации с этапами, коммуникациями и миграцией.
CC0-1.0 ★ 178 201 обновлён 2026-10-24
Открыть на GitHubЧто делает API Deprecation and Sunset Plan Builder (YAML)
Этот промпт заставляет ИИ действовать как старший инженер API-платформы. Вы предоставляете данные о том, что именно планируется отключить, кто использует этот функционал и какие существуют ограничения, а модель генерирует полный план в формате YAML.
Промпт требует четкого соблюдения схемы, включая этапы жизненного цикла, сигналы для пользователей, стратегию миграции и перечень открытых вопросов. Если данных недостаточно, модель задаст до 4 уточняющих вопросов, прежде чем составить финальный документ.
Какие задачи решает
- создать план вывода из эксплуатации API
- структурировать этапы миграции для пользователей
- описать риски и способы их смягчения
- подготовить список коммуникаций для разных аудиторий
Примеры запросов агенту
- Создай план вывода из эксплуатации для GET /v1/invoices/{id}/pdf, который заменяется на новый эндпоинт
- Составь YAML-план для депрекации SDK-метода, учитывая, что его используют мобильные приложения
- Напиши план sunset для старой версии API, у которой есть жесткие сроки комплаенса
Как установить API Deprecation and Sunset Plan Builder (YAML)
Как использовать
Вставьте текст в начало диалога или в инструкции проекта
Вручную: положить файлы
.claude/commands/prompts.csv.mdВопросы об API Deprecation and Sunset Plan Builder (YAML)
Как использовать API Deprecation and Sunset Plan Builder?
Скопируйте текст промпта в чат с ИИ и предоставьте описание API, которое нужно вывести из эксплуатации. Модель проанализирует ввод и выдаст структурированный YAML-файл.
Что делает этот промпт?
Он преобразует неструктурированную информацию об устаревании API в формализованный план, охватывающий timeline, сигналы для клиентов, стратегию brownout и шаги по очистке кода.
Нужно ли предоставлять все данные сразу?
Нет, промпт настроен на уточнение критически важных деталей. Если вы не укажете данные об использовании или аудитории, ИИ задаст до 4 вопросов, чтобы план получился реалистичным.
Исходный текст
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