Skip to content

docs: fix protection-config example schema and missing delegated-auth package mention - #1037

Open
jiashuoz wants to merge 1 commit into
mainfrom
claude/relaxed-cerf-nzxqy4
Open

jiashuoz wants to merge 1 commit into
mainfrom
claude/relaxed-cerf-nzxqy4

Conversation

@jiashuoz

Copy link
Copy Markdown
Member

Summary

Scheduled documentation audit pass (Markdown-only), cross-checked against api/openapi.yaml, internal/ package structure, and the actual update_protection request schema. Before starting, I checked open PRs/branches and confirmed PR #1011 already covers the Go-toolchain-version and internal/sendingpolicy/E2A_OIDC_LOGOUT_URL doc gaps — those are intentionally excluded here to avoid duplicating that work.

  • plugins/e2a/docs/setup.md, plugins/e2a/skills/e2a/SKILL.md — the "require human review for every outbound email" example called update_protection with a flat body (outbound_gate_policy, outbound_gate_allowlist, outbound_gate_action, holds_on_expiry). The actual ProtectionConfigRequest schema (api/openapi.yaml) requires the nested inbound/outbound/holds shape, and every level sets additionalProperties: false — so an agent following the old example verbatim would get the request rejected. Fixed both to the nested shape matching the schema (and the correct example already in README.md). Regenerated the derived mirror web/public/setup.md and web/public/llms-full.txt via node scripts/sync-agent-docs.mjs.
  • AGENTS.md — the "Auth" package list under "Backend architecture" omitted internal/delegated (RFC 9068 delegated access-token verification, E2A_DELEGATED_ENABLED), even though it's a real, fully documented feature elsewhere (docs/deployment.md, docs/observability.md metrics, its own prober scenario). Added it to the inventory.
  • Bumped the e2a plugin version (0.9.50.9.6) for the SKILL.md content fix and regenerated the derived plugin manifests via node scripts/generate-plugin-manifests.mjs (required by the plugin version-bump CI gate).

No behavior changes — documentation and generated-manifest changes only.

Operational risk

None — Markdown/JSON manifest changes only; no code paths touched.

Test plan

  • Verified the corrected JSON body against api/openapi.yaml's ProtectionConfigRequest/ProtectionDirectionRequest/ProtectionGateRequest/ProtectionScanRequest/ProtectionHoldsRequest schemas (all required fields present, no additionalProperties violations).
  • Verified internal/delegated exists and is documented elsewhere (docs/deployment.md:33,212).
  • node scripts/sync-agent-docs.mjs --check — passes.
  • node scripts/generate-plugin-manifests.mjs then node scripts/validate-plugin.mjs — passes, no drift.
  • node scripts/check-plugin-version-bump.mjs origin/main — passes.
  • bash scripts/check-repository-text-integrity.sh — passes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NH4faSeyu6Gdk23qEBPr5b


Generated by Claude Code

… package mention

Documentation audit pass, cross-checked against api/openapi.yaml and
internal/ package structure:

- plugins/e2a/docs/setup.md and plugins/e2a/skills/e2a/SKILL.md showed a
  flat update_protection request body (outbound_gate_policy,
  outbound_gate_allowlist, outbound_gate_action, holds_on_expiry). The
  actual ProtectionConfigRequest schema requires the nested
  inbound/outbound/holds shape (every level has
  additionalProperties: false), so an agent following the old example
  verbatim would get its request rejected. Fixed both to the nested
  shape and regenerated web/public/setup.md via
  scripts/sync-agent-docs.mjs.
- AGENTS.md's "Auth" package list omitted internal/delegated (RFC 9068
  delegated access-token verification, E2A_DELEGATED_ENABLED) even
  though it's a fully documented feature elsewhere (docs/deployment.md,
  docs/observability.md, its own prober scenario).
- Bumped the e2a plugin version (0.9.5 -> 0.9.6) for the SKILL.md fix and
  regenerated the derived plugin manifests via
  scripts/generate-plugin-manifests.mjs.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NH4faSeyu6Gdk23qEBPr5b
@jiashuoz jiashuoz self-assigned this Sep 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants