Interface Deprecation

Migration signal returned by deprecated endpoints. Optional fields are omitted when they have no value.

interface Deprecation {
    docsUrl?: string;
    message: string;
    replacement?: string;
    sunsetAt?: string;
}

Properties

docsUrl?: string

Link to the migration documentation (markdown), when available.

message: string

Human- and agent-readable summary of the deprecation and its replacement.

replacement?: string

The replacement endpoint, e.g. "GET /api/public/v2/observations". Omitted when the endpoint is being removed without a direct replacement.

sunsetAt?: string

ISO date after which the endpoint may stop working, when a removal date is committed.