docs: ERROR_CODES — consolidate as single source of truth#5
Merged
Conversation
- 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>
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
docs/ERROR_CODES.mdas the single source of truth for the entire stack.bsp-contracts,bsp-registry-api) now link here instead of duplicating tables — companion PRs submitted.Aggregated content
bsp-contracts/docs/ERROR_CODES.md(beo_registry, ieo_registry, domain_registry, access_control, governance).bsp-registry-api/docs/ERROR_CODES.md(auth, consent exchange, nonce/replay, guardians, Arweave, Aptos circuit breaker, institute/admin).Test plan
bsp-contractsandbsp-registry-apiare ready🤖 Generated with Claude Code