AI Prompt Reference
Log in
Back to library
DevelopmentGPT-5ArchitectureDevOpsRisk

API Version Migration Plan

Design API evolution, deprecation, and migration without disrupting clients.

API Version Migration Plan

Prompt

# Role
You are a senior software engineer and technical lead. Establish evidence and invariants first, then propose the smallest verifiable and reversible implementation.

# Objective
Complete “API Version Migration Plan”: Design API evolution, deprecation, and migration without disrupting clients.

# Required Input
Current contract, field changes, clients, traffic, compatibility window, auth, error semantics, release cadence, and rollback constraints.

If information is missing, ask up to five high-information questions. Otherwise begin directly.

# Execution Protocol
1. Confirm goal, constraints, environment, symptom, and evidence.
2. List invariants, hypotheses, and cheap falsification checks.
3. Compare correctness, complexity, performance, security, migration, and rollback.
4. Provide implementation, test matrix, release gates, and monitoring.

# Required Deliverables
Breaking-change analysis; compatibility layer; version policy; timeline; client guide; contract tests; telemetry; deprecation and rollback gates.

# Acceptance Criteria
Known clients are traceable; deprecation uses usage data; error semantics stay compatible; shutdown has thresholds and notification evidence.

# Shared Constraints
Never invent facts, data, certifications, reviews, or sources. Label assumptions and verification methods. Put the copy-ready deliverable first and finish with a five-point self-review and corrections.

Curated by the editorial team · Updated 07/23/2026 · Model: GPT-5

Usage guide

How to use this prompt

This template is designed for development tasks. Replace the sample details with real constraints before running it in GPT-5.

  1. Step 1

    State the stack, runtime, inputs, outputs, and existing constraints.

  2. Step 2

    Ask for the approach and risks before requesting the smallest verifiable change.

  3. Step 3

    Run tests, type checks, and critical scenarios locally before merging.

Details to replace or add

Specific inputs produce more useful results. Do not submit passwords, private information, or confidential business data.

  • Language, framework, and versions
  • Current code and error output
  • Expected inputs and outputs
  • Compatibility and performance constraints
  • Acceptance test cases

Output checklist

  • The code runs on the specified versions
  • Edge cases and errors are handled
  • Existing project patterns are reused
  • Tests cover critical behavior
  • No new security or performance risk appears

Common adjustments

Provide the directory structure and interfaces when the answer drifts from the project.

Limit files and request staged changes when the proposal is too broad.

Ask for runnable test commands and expected output when verification is unclear.

This prompt separates Development, Architecture, DevOps, Risk requirements into context, constraints, and output format. Keep the objective fixed and revise only the conditions that failed before rewriting the whole template.

Related prompts

Explore more templates in Development.