liveBook · Manning

Deleted state

As explained in API Design Patterns

Deleted is the API version lifecycle state in which a version has been removed and is no longer accessible.

Deleted is the terminal API version state: a previously deprecated version has been removed or made inaccessible to users. It ends that version’s lifecycle and permits no further changes. section 24.3.2

Treat deletion as the final step in a sliding-window version policy:

  • Move a version from deprecated to deleted only after its scheduled removal point. section 24.3.2
  • Expect clients to lose access after deletion; unlike current and deprecated versions, the state has no permitted changes. section 24.3.2

Sliding-window timeline

In the illustrated timeline, version 1 is preview in January, current in February, deprecated in March and April, and deleted in May. Newer versions occupy the active stages as version 1 approaches removal. section 24.3.2

Table 24.1 Overview of different version states (view table figure)

State

Description

Change policy

Preview

An unstable and still-in-progress preview of functionality users should expect to exist in the next current version

All changes permitted

Current

A very stable set of functionality that should not change and can be expected to continue running for some pre-decided amount of time

Only mandatory changes

Deprecated

A prior current version that is scheduled for impending removal according to the deprecation policy

Only mandatory changes

Deleted

A prior deprecated version that has been removed or otherwise made inaccessible to users

N/A

Use the state table to compare deleted with preview, current, and deprecated, including each state’s permitted change policy. section 24.3.2

How API Design Patterns covers it

How deep it goes
Defines deletion and places it in a lifecycle table and timeline, without detailing removal implementation.
Examples
Uses a five-month timeline where version 1 progresses from preview through current and deprecated to deleted.
What it assumes
Assumes familiarity with API versions and teaches their preview-to-deleted lifecycle.
What you can do after
Evaluate when an API version has reached removal and distinguish deletion from deprecation.
How it connects
Connects API versioning with preview, current, deprecated, deprecation policy, and compatibility.
Cover of API Design Patterns
liveBookmanning.com
Read API Design Patterns on liveBook Get the book at manning.com

Related concepts

This explainer was generated by Manning's knowledge graph from the text of API Design Patterns. The section links point to the parts of the book it draws on.