feat(docs+compliance): implementer DX — troubleshooting, known-ambiguities, idempotency opt-out (#2607, #2608)#2613
Merged
Conversation
idempotency.yaml: add omit_idempotency_key: true to the missing-key vector so the runner skips applyIdempotencyInvariant + SDK auto-inject. The SDK already supports this opt-out (Step.omit_idempotency_key → skipIdempotencyAutoInject); the storyboard declaration was the missing piece. storyboard-schema.yaml documents the field. docs/building/implementation/storyboard-troubleshooting.mdx: error pattern → fix reference — unknown fixtures, RFC 9421 signature challenges, envelope drift, context echo, capability mismatches, requireAuthenticatedOrSigned, INVALID_STATE vs INVALID_TRANSITION. docs/building/implementation/known-ambiguities.mdx: open spec gaps with workarounds + issue links. Entries removed as issues close. docs.json nav registers both pages (both Implementation Patterns arrays updated). validate-your-agent.mdx cross-links via a new "When a storyboard fails" section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
Schema Link Check ResultsCommit:
|
- storyboard-troubleshooting.mdx: #request-signing → #signed-requests-transport-layer, #state-machine-transitions → #scenarios (both were broken) - known-ambiguities.mdx: remove past_start entry (closed by #2389), tighten intro - conformance.mdx: add "When a storyboard fails" section linking to both pages - troubleshooting footer: drop "under an hour" language Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two implementer-facing docs pages + a one-line storyboard edit that unblocks the idempotency missing-key vector through the reference SDK.
Closes #2607, closes #2608.
Signature error taxonomy
The troubleshooting guide references `RequestSignatureError` from `@adcp/client/signing` with `.code: RequestSignatureErrorCode` (not `signatureErrorCodeFromCause` — that symbol does not exist in the SDK). Full taxonomy: `request_signature_required`, `request_signature_header_malformed`, `request_signature_tag_invalid`, `request_signature_window_invalid`, `request_signature_key_unknown`, and 11 more.
Scope notes
Test plan
🤖 Generated with Claude Code