Skip to content

docs: ERROR_CODES — consolidate as single source of truth#5

Merged
sirambrosio merged 5 commits into
mainfrom
docs/consolidate-and-polish
Apr 20, 2026
Merged

docs: ERROR_CODES — consolidate as single source of truth#5
sirambrosio merged 5 commits into
mainfrom
docs/consolidate-and-polish

Conversation

@sirambrosio
Copy link
Copy Markdown
Contributor

Summary

  • Consolidate all BSP error codes into docs/ERROR_CODES.md as the single source of truth for the entire stack.
  • Downstream repos (bsp-contracts, bsp-registry-api) now link here instead of duplicating tables — companion PRs submitted.
  • Structured in four parts: protocol-level string codes, Registry API HTTP codes, Move abort codes (per module range), SDK/CLI/MCP surface notes.

Aggregated content

  • 78 Move abort codes merged in from bsp-contracts/docs/ERROR_CODES.md (beo_registry, ieo_registry, domain_registry, access_control, governance).
  • 31 HTTP/machine codes merged in from bsp-registry-api/docs/ERROR_CODES.md (auth, consent exchange, nonce/replay, guardians, Arweave, Aptos circuit breaker, institute/admin).
  • SDK (TS/Python), CLI, and MCP error surfaces documented with the protocol codes they emit.

Test plan

  • All original Part I codes preserved (no renames)
  • Stability guarantee section retained
  • Cross-reference table updated to current repo layout
  • Merge after companion PRs in bsp-contracts and bsp-registry-api are ready

🤖 Generated with Claude Code

sirambrosio and others added 5 commits April 20, 2026 10:08
- docs/ARCHITECTURE.md: system diagram + sequence diagrams for create BEO,
  grant ConsentToken, submit BioRecord, and destroy BEO flows. Component
  responsibilities + trust boundaries documented.
- docs/GLOSSARY.md: canonical definitions for BEO, IEO, BioRecord,
  ConsentToken, Scope, Intent, Domain, Guardian, Recovery, Relayer, and
  taxonomy terms. Normative — all implementations MUST use these meanings.
- docs/ERROR_CODES.md: consolidated stable error code catalog cross-linked
  to contracts, API, SDK, CLI, and MCP sources.
- docs/SLA.md: 99.5% monthly uptime target for Registry API, P95 <500ms
  for reads and <3s for writes, maintenance windows, incident
  classification, communication channels, data integrity guarantees,
  SLA breach reporting procedure.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Merge contracts (78 abort_codes) + API (31 machine codes) + SDK/CLI/MCP
surfaces into one canonical catalog. Downstream repos will link here
instead of duplicating tables.

Structure:
- Part I — Protocol-level string codes (SDK/CLI/MCP)
- Part II — Registry API HTTP + machine codes
- Part III — Move abort_code ranges per module
- Part IV — SDK / CLI / MCP surface notes

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sirambrosio sirambrosio merged commit 8015165 into main Apr 20, 2026
1 check failed
@sirambrosio sirambrosio deleted the docs/consolidate-and-polish branch April 20, 2026 15:31
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.

1 participant