schemas(reporting-webhook, auth-scheme): deprecate HMAC-SHA256 recommendation, point at RFC 9421#4273
Conversation
…endation, point at RFC 9421 Two schema-description-only edits, no normative change. Surfaces existing push-notification-config.json framing at adjacent schemas where SDK authors actually read them. reporting-webhook.json — the authentication.schemes description previously said HMAC-SHA256 was "recommended for production", contradicting push-notification-config.json's framing (both Bearer + HMAC-SHA256 are deprecated legacy fallback, removed in AdCP 4.0). New buyers reading the schema in isolation were being steered toward the legacy on-ramp. Description now mirrors push-notification-config — both schemes deprecated, removed in 4.0, see push-notification-config for the precedence model. auth-scheme.json — the enum's description was silent about deprecation. SDK authors loading the enum in isolation had no signal these were legacy options. Description now states the values are scoped to the legacy authentication block and points readers at the RFC 9421 default. Out of scope (surfaced for maintainer triage in adcontextprotocol#4270): reporting-webhook still has authentication in `required`, which means reporting webhooks have no opt-in path to RFC 9421 today. Mirroring push-notification-config's structural shape (auth block optional, omitted = 9421 default) is a separate normative question. Closes the schema-description sub-item of adcontextprotocol#4270. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
I have read the IPR Policy |
IPR Policy Agreement Required@EvgenyAndroid — thanks for the contribution. Before this PR can be merged, the AgenticAdvertising.Org IPR Policy requires your agreement. To agree, post a new comment on this PR with the exact phrase: Your signature is recorded once and covers all contributions to AAO repositories. See |
|
I have read the IPR Policy |
IPR Policy — signedThanks, @EvgenyAndroid. Your agreement to the IPR Policy is recorded at |
|
Deferring to #4271 per @bokelley's triage comment on #4270. #4271 is atomic, targets |
First pass on the schema-description sub-item of #4270 (storyboard / SDK-skill on-ramp inventory). Surgical, source-only, no normative change — mirrors precedent #2506.
Why
push-notification-config.json'sauthenticationfield was already updated in #2506 to mark Bearer / HMAC-SHA256 as the deprecated legacy fallback removed in AdCP 4.0, with RFC 9421 as the default. Two adjacent schemas were left out of that pass and still steer new buyers toward the HMAC on-ramp:static/schemas/source/core/reporting-webhook.json—authentication.schemesdescription literally says HMAC-SHA256 is "recommended for production". Contradicts push-notification-config.json. Active mis-direction for any new buyer reading the schema in isolation.static/schemas/source/enums/auth-scheme.json— enum-level description doesn't mention deprecation at all. SDK authors loading the enum without cross-referencing push-notification-config.json have no signal these are legacy options.What this PR does
reporting-webhook.json(1 line): replace "['HMAC-SHA256'] for signature verification (recommended for production)" with the same "both deprecated, removed in 4.0, see push-notification-config" framing already used in push-notification-config.json.auth-scheme.json(1 line): extend the description to state these enum values are scoped to the legacyauthenticationblock and point readers at the RFC 9421 default..changeset/4270-deprecate-hmac-recommendation-in-schemas.md: changeset entry.No
dist/regen;static/schemas/source/is the source of truth andbuild:schemasregeneratesdist/at release.What's NOT in this PR (deliberately scoped out — maintainer call)
reporting-webhook.jsonhasauthenticationinrequired: [...]. That's a structural asymmetry vspush-notification-config.json(where the block is optional and absence selects 9421). Today there is no opt-in path to RFC 9421 for reporting webhooks — every reporting buyer is forced through the legacy auth block.That's a normative question, not a description fix, so it stays in #4270 for triage. If the spec intends symmetry with push-notification-config.json, follow-up PR drops
\"authentication\"from therequiredarray and mirrors push-notification-config's framing on the field. Happy to take that as a follow-up if maintainers triage favorably.Test plan
static/schemas/source/core/reporting-webhook.jsonparses (JSON syntactically valid, no schema shape change)static/schemas/source/enums/auth-scheme.jsonparsesdist/files modified — release build regenerates from sourceCross-references
I have read the IPR Policy