Skip to content

docs: fix stale beta-operation count, add missing CLI/SDK references - #1071

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

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

Conversation

@jiashuoz

@jiashuoz jiashuoz commented Oct 5, 2026

Copy link
Copy Markdown
Member

Summary

Documentation-only fixes found in a repo-wide staleness audit. Checked for overlap with open docs PRs first (#1037's protection-config schema fix, #1060's account.delete() docs) — none of this overlaps.

  • docs/api.md: the stability-surface summary sentence said "31 beta operations," but the detailed table right below it, and the full beta-operations table later in the doc (pinned by TestDocumentedBetaOperationsMatchOpenAPI), both list 33. Recounted directly from api/openapi.yaml's x-stability-level tags: 43 GA + 33 beta = 76 total operations. Fixed the summary sentence to match.
  • README.md: the CLI command table was missing two real, documented top-level commands — e2a account delete and e2a sending-access status|request — both wired in cli/src/bin/e2a.ts and documented in cli/README.md, just never surfaced in the root README's table.
  • sdks/typescript/README.md / sdks/python/README.md: the Resources section documented the beta getLifecycle/get_lifecycle method but never mentioned its siblings messages.getMetrics()/get_metrics() and account.metrics(), which already ship in both SDKs (5.7.0) and are extensively documented on the CLI side (e2a metrics) but were absent from the SDK docs entirely.

Client surface checklist

Not applicable — docs-only change, no API/client code touched.

Test plan

  • Verified the 43/33/76 operation counts directly against api/openapi.yaml (x-stability-level field).
  • Verified e2a account delete and e2a sending-access exist as real case branches in cli/src/bin/e2a.ts and are documented in cli/README.md.
  • Verified getMetrics/metrics() (TS) and get_metrics/metrics() (Python) exist in sdks/typescript/src/v1/client.ts and sdks/python/src/e2a/v1/client.py respectively.

🤖 Generated with Claude Code

https://claude.ai/code/session_017YTaQzrVUnHyWDPHq4u1Nz


Generated by Claude Code

- docs/api.md: the summary sentence said "31 beta operations" while the
  detailed table immediately below it (and the full beta-operations table
  later in the doc, which TestDocumentedBetaOperationsMatchOpenAPI pins)
  both list 33. Corrected the summary to match api/openapi.yaml's actual
  33 beta / 43 GA / 76 total operations.
- README.md: the CLI command table omitted `e2a account delete` and
  `e2a sending-access status|request`, both real top-level commands wired
  in cli/src/bin/e2a.ts and documented in cli/README.md.
- sdks/typescript/README.md, sdks/python/README.md: the Resources section
  documented `getLifecycle`/`get_lifecycle` but never mentioned the
  sibling `messages.getMetrics()`/`get_metrics()` or
  `account.metrics()` methods, which ship in the SDKs today.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017YTaQzrVUnHyWDPHq4u1Nz
@jiashuoz jiashuoz self-assigned this Oct 5, 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