Beta This developer portal is in beta — APIs and documentation may change without notice.
Operations

Migration guides

Step-by-step walkthroughs for breaking API changes. When a product ships a breaking version, a dated guide lands here so integrators can upgrade with confidence.

No breaking changes have shipped yet. The APIs are still in beta, so there's nothing to migrate from. The template and worked example below define how a guide will look when the first breaking change lands.

Available guides

AuditPic — v1 → v2 (example)

A worked example showing the shape of a real guide: what broke, the before/after request, and a step-by-step upgrade path. This is illustrative — AuditPic has not shipped a v2.

Example AuditPic

Example: AuditPic v1 → v2

What changed. The image-signing response moved the HMAC digest from a top-level signature field into a structured integrity object, and the algorithm is now explicit.

// Before (v1) { "id": "img_123", "signature": "9f86d081…" } // After (v2) { "id": "img_123", "integrity": { "algorithm": "HMAC-SHA256", "digest": "9f86d081…" } }

Upgrade steps

  1. 1. Read the digest from the new location

    Replace response.signature with response.integrity.digest.

  2. 2. Pin the algorithm

    Verify response.integrity.algorithm === "HMAC-SHA256" before validating.

  3. 3. Send the version header

    Add Accept: application/vnd.auditpic.v2+json to opt in; v1 stays the default until deprecation.

Guide template

Copy this skeleton when authoring a new guide. Keep it short, concrete, and runnable — one before/after pair per breaking change.

# <Product> — <old version> → <new version> **Date:** YYYY-MM-DD **Severity:** breaking ## What changed One paragraph: what broke and why. ## Before / after A minimal request + response showing the old and new shape. ## Upgrade steps 1. … 2. … ## Deprecation timeline When the old version stops being accepted.