Commit 01a1068
docs(migration)!: add v4.0 → v4.1 migration guide (#302)
Document the three breaking changes folded into the 4.1 release so
upgraders have a single artifact to consult:
1. ``ADCPClient.pending_task_id`` → ``ADCPClient.active_task_id``
(and the same on ``A2AAdapter``); ``context_id=`` / ``reset_context()``
raise ``TypeError`` instead of ``ValueError`` on non-A2A protocols.
2. ``FormatId.__name__`` is now ``"FormatReferenceStructuredObject"``
because AdCP 3.0.1 polished ``core/format-id.json``'s title.
Public ``FormatId`` keeps working via the aliases module; pickled
instances and reflection on ``__name__`` break.
3. ``MEDIA_BUY_STATE_MACHINE`` no longer has ``pending_activation`` —
replaced with the spec-correct ``pending_creatives`` and
``pending_start``.
BREAKING CHANGE: ``FormatId.__name__`` and ``__qualname__`` change
from ``"FormatId"`` to ``"FormatReferenceStructuredObject"`` because
AdCP 3.0.1 polished the schema title on ``core/format-id.json``. The
public ``adcp.FormatId`` alias keeps working — ``Format(format_id=
FormatId(...))`` and ``isinstance(x, FormatId)`` are unchanged. Two
niche cases break: pickled ``FormatId`` instances from 4.0 fail to
unpickle on 4.1, and snapshot tests / log scrapers asserting on
``__name__`` see the rename. See MIGRATION_v4.0_to_v4.1.md.
BREAKING CHANGE: ``MEDIA_BUY_STATE_MACHINE`` no longer accepts
``"pending_activation"`` as a key — that string is not part of the
AdCP v3 ``enums/media-buy-status.json``. ``valid_actions_for_status
("pending_activation")`` now returns ``[]``. Use ``"pending_creatives"``
(creatives still awaiting approval) or ``"pending_start"`` (creatives
approved, awaiting flight start) per the spec. See
MIGRATION_v4.0_to_v4.1.md.
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 7be949c commit 01a1068
1 file changed
Lines changed: 98 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
0 commit comments