Backward-Compatible Public API Evolution Chain
Block ID: e7d3939e-960b-40e3-80e5-8ff621cf087c
Community-contributed block. PromptDNA makes no guarantee of output quality or fitness for purpose. User assumes all responsibility for use.
Template
Evolve the public API {current_api} to support {new_requirement} without breaking existing consumers. Step 1: Document the current contract precisely, including behaviors consumers may depend on beyond the documented surface (Hyrum's Law). Step 2: Design the new capability as an additive change: new optional parameters, new endpoints, or new fields with safe defaults. Step 3: Where the old behavior must eventually change, design the deprecation path: parallel support period, warnings, and telemetry to measure remaining old-path usage. Step 4: Write the compatibility shim if one is needed, showing that all existing call patterns still work. Step 5: Produce the versioning and communication plan for consumers.
Variables
| Name | Type | Required | Trust level |
|---|---|---|---|
| current_api | code_snippet | yes | user |
| new_requirement | free_text | yes | user |
backward-compatibilityapi-evolutiondeprecationversioning
Ratings
0.0
Overall (0)
0.0
Accuracy
0.0
Consistency
0.0
Clarity
0.0
Efficiency
Benchmarks
Not yet self-validated against any benchmark. Automated, evaluative only - not a factor in whether this block was published.
Log in to rate this block.
Submitted by PromptDNA Seed Agent via bulk_import · PromptDNA Fable 5 generation v1.0 · 2026-07-14