cortexdbai 0.12.0__tar.gz → 0.13.1__tar.gz

cortexdbai-0.13.1/COVERAGE.md

@@ -0,0 +1,329 @@
+# `cortexdbai` coverage of the CortexDB 0.14.0 v1 API
+
+Every route the 0.14.0 server serves to clients, and the `cortexdbai` method that calls it. Every method exists in
+`V1Client` and in `AsyncV1Client` under the same name, with the same parameters (both are built from the same
+builders, `cortexdb/v1/ops/`, and `tests/test_client_parity.py` pins it). Kept up to date with the SDK: a route the
+server adds goes in this table in the same change.
+
+## How the list was made
+
+- **The server's route table.** Every `.route("…")` under `crates/cortex-api/src/` that is compiled into the binary
+  (test code is skipped the way `scripts/openapi_route_diff.py` skips it), for the public prefixes the OpenAPI gate
+  covers: `/v1/`, `/access/`, `/.well-known/` and `/scim/`. That is `crates/cortex-api/src/v1/router.rs` and every
+  router it mounts (`access_routes.rs`, `access_change_routes.rs`, `access_watch.rs`, `app_routes.rs`,
+  `directory_routes.rs`, `scim_routes.rs`, `restore_routes.rs`, `rollup_routes.rs`, `publish_routes.rs`,
+  `forget_routes*.rs`, `code_routes.rs`, `commitment_routes.rs`, `source_erasure_routes.rs` and the rest).
+- **Base:** `origin/sharedcontext` at `4618df85`, the final 0.14.0 server, 206 paths and 237 operations (a path with
+  two methods is two rows). The field families are in the second table.
+- **The method column** is read from the SDK itself: each method's docstring names its route first.
+- **Status:** `covered` (both clients), or `not covered` with the reason.
+
+## How it is tested
+
+- **Unit** (`tests/`, run by CI's `pytest -q` in `sdks/python`): every method on both clients sends the same
+  request (`test_client_parity.py`), and each route family's tests pin its requests and its answers' handling.
+- **Live** (`tests/live/`, against a release binary of the merged tree, `CORTEXDB_BINARY=… pytest tests/live`): one
+  org's life in 25 legs, run once on each client. The last leg calls every route the others do not, and checks that
+  each answers by its contract on a default server: 2xx, or the documented refusal of a switch the server leaves off
+  (`CODE_PLANE_DISABLED`, `COHORT_DISABLED`, `ICE_OFF`, plans' 404, the native memory host's routes, which a
+  plain server does not mount). With `CORTEXDB_LIVE_ROUTES=<file>` the run records every request it sent: on 0.14.0
+  it reaches 229 of the 235 covered operations (signup's class method included); the other six are aliases of reached routes (`GET /v1/health`,
+  `/v1/ready`, `/v1/understanding/coverage`, `/v1/understanding/{id}` and `/{id}/related`, `POST
+  /v1/experiences`), which the method's own route serves.
+
+## Not part of the SDK
+
+These are served by the binary but are not the v1 API a client calls:
+
+| Route | Why not |
+|---|---|
+| `POST`, `GET`, `DELETE /mcp` | The HTTP MCP server (`CORTEX_MCP=on`): an MCP client's transport, covered by MCP clients, not by this SDK |
+| `/internal/ui/*` | The embedded console's own routes (settings, features, license, updater); 403 on a data node, not routed by an ingress |
+| `/metrics` | Prometheus text exposition, for a scraper |
+| `/`, `/status`, `/assets/*`, `/docs*`, `/openapi.json` | The console and its static files; `/openapi.json` is the same document as `GET /v1/openapi.json` |
+| `/shard/v1/*`, `/node/v1/*` | A cluster's internal mTLS routes, between nodes |
+| `GET /.well-known/oauth-protected-resource`, `/.well-known/oauth-protected-resource/mcp` | The MCP server's OAuth protected-resource metadata (RFC 9728), read by MCP clients; listed below because the OpenAPI gate covers `/.well-known/` |
+
+## Summary
+
+237 operations: 235 covered by both clients, 2 not covered (each row says why).
+
+Before the 0.14.0 work (`cortexdbai` 0.12.0), 67 operations were reached, 49 of them only partly (38 had no
+`AsyncV1Client` method), and none of the shared-memory routes.
+
+## Routes
+
+| Route | Family | Method (`V1Client` and `AsyncV1Client`) | Status |
+|---|---|---|---|
+| `GET /.well-known/authzen-configuration` | AuthZEN | `authzen_configuration` | covered |
+| `GET /.well-known/oauth-protected-resource` | MCP metadata | - | not covered: the MCP server's OAuth metadata, for MCP clients (see above) |
+| `GET /.well-known/oauth-protected-resource/mcp` | MCP metadata | - | not covered: the MCP server's OAuth metadata, for MCP clients (see above) |
+| `POST /access/v1/evaluation` | AuthZEN | `authzen_evaluation` | covered |
+| `POST /access/v1/search/resource` | AuthZEN | `authzen_search_resource` | covered |
+| `GET /scim/v2/Groups` | SCIM | `scim.list_groups` | covered |
+| `POST /scim/v2/Groups` | SCIM | `scim.create_group` | covered |
+| `DELETE /scim/v2/Groups/{id}` | SCIM | `scim.delete_group` | covered |
+| `GET /scim/v2/Groups/{id}` | SCIM | `scim.get_group` | covered |
+| `PATCH /scim/v2/Groups/{id}` | SCIM | `scim.patch_group` | covered |
+| `PUT /scim/v2/Groups/{id}` | SCIM | `scim.replace_group` | covered |
+| `GET /scim/v2/ResourceTypes` | SCIM | `scim.resource_types` | covered |
+| `GET /scim/v2/ResourceTypes/{id}` | SCIM | `scim.resource_type` | covered |
+| `GET /scim/v2/Schemas` | SCIM | `scim.schemas` | covered |
+| `GET /scim/v2/Schemas/{id}` | SCIM | `scim.schema` | covered |
+| `GET /scim/v2/ServiceProviderConfig` | SCIM | `scim.service_provider_config` | covered |
+| `GET /scim/v2/Users` | SCIM | `scim.list_users` | covered |
+| `POST /scim/v2/Users` | SCIM | `scim.create_user` | covered |
+| `DELETE /scim/v2/Users/{id}` | SCIM | `scim.delete_user` | covered |
+| `GET /scim/v2/Users/{id}` | SCIM | `scim.get_user` | covered |
+| `PATCH /scim/v2/Users/{id}` | SCIM | `scim.patch_user` | covered |
+| `PUT /scim/v2/Users/{id}` | SCIM | `scim.replace_user` | covered |
+| `POST /v1/access/accounts/resolve` | Source containers | `access_resolve_accounts` | covered |
+| `POST /v1/access/changes` | Change sets | `changeset_stage` | covered |
+| `DELETE /v1/access/changes/{id}` | Change sets | `changeset_discard` | covered |
+| `GET /v1/access/changes/{id}` | Change sets | `changeset_get` | covered |
+| `POST /v1/access/changes/{id}/activate` | Change sets | `changeset_activate` | covered |
+| `POST /v1/access/changes/{id}/parts` | Change sets | `changeset_add_parts` | covered |
+| `POST /v1/access/changes/{id}/preview` | Change sets | `changeset_preview` | covered |
+| `POST /v1/access/check` | Access API | `access_check` | covered |
+| `GET /v1/access/enrich` | Access API | `access_enrich` | covered |
+| `POST /v1/access/explain` | Access API | `access_explain` | covered |
+| `GET /v1/access/limits` | Access API | `access_limits` | covered |
+| `POST /v1/access/lookup/principals` | Access API | `access_lookup_principals` | covered |
+| `POST /v1/access/lookup/scopes` | Access API | `access_lookup_scopes` | covered |
+| `GET /v1/access/notices` | Watch and notices | `access_notices` | covered |
+| `POST /v1/access/notices/ack` | Watch and notices | `access_notices_ack` | covered |
+| `GET /v1/access/records` | Restores | `access_records` | covered |
+| `POST /v1/access/rehome` | Source containers | `access_rehome` | covered |
+| `POST /v1/access/restore/ack` | Restores | `access_restore_ack` | covered |
+| `POST /v1/access/texts/erase` | Access API | `access_texts_erase` | covered |
+| `GET /v1/access/watch` | Watch and notices | `access_watch` | covered |
+| `GET /v1/access/watermarks` | Source containers | `access_watermarks` | covered |
+| `PUT /v1/access/watermarks` | Source containers | `access_watermark_put` | covered |
+| `GET /v1/admin/access/report` | Access admin | `admin_access_report` | covered |
+| `POST /v1/admin/access/restore` | Restores | `admin_access_restore` | covered |
+| `POST /v1/admin/access/tenant-binding` | Access admin | `admin_tenant_binding` | covered |
+| `GET /v1/admin/access/tenant-settings` | Access admin | `admin_tenant_settings` | covered |
+| `PUT /v1/admin/access/tenant-settings` | Access admin | `admin_set_tenant_settings` | covered |
+| `POST /v1/admin/auth/reload` | Access admin | `admin_auth_reload` | covered |
+| `GET /v1/admin/cohort/status` | Cohort (xscope) | `admin_cohort_status` | covered |
+| `POST /v1/admin/cohort/warm` | Cohort (xscope) | `admin_cohort_warm` | covered |
+| `POST /v1/admin/compaction/dedup` | Admin | `admin_compaction_dedup` | covered |
+| `GET /v1/admin/compile-dead-letter` | Admin | `admin_compile_dead_letter` | covered |
+| `POST /v1/admin/derived/rederive` | Admin | `admin_rederive` | covered |
+| `GET /v1/admin/derived/rederive/{job_id}` | Admin | `admin_rederive_status` | covered |
+| `POST /v1/admin/derived/resolver/unmerge` | Admin | `admin_resolver_unmerge` | covered |
+| `GET /v1/admin/events/{id}/chunks` | Admin | `event_chunks` | covered |
+| `GET /v1/admin/health` | Admin | `health` | covered |
+| `POST /v1/admin/ice/owner` | Admin | `admin_ice_owner` | covered |
+| `POST /v1/admin/ice/seal` | Admin | `admin_ice_seal` | covered |
+| `GET /v1/admin/ice/status` | Admin | `admin_ice_status` | covered |
+| `POST /v1/admin/index-audit` | Admin | `index_audit` | covered |
+| `GET /v1/admin/index-audit/orphan-blobs` | Admin | `admin_orphan_blobs` | covered |
+| `POST /v1/admin/index-audit/reinclude` | Admin | `admin_reinclude` | covered |
+| `POST /v1/admin/index-audit/source-blob-links` | Admin | `admin_source_blob_links` | covered |
+| `GET /v1/admin/layers/stats` | Admin | `layer_stats` | covered |
+| `GET /v1/admin/metrics` | Admin | `admin_metrics` | covered |
+| `GET /v1/admin/native-memory` | Admin | `admin_native_memory` | covered |
+| `POST /v1/admin/persist` | Admin | `admin_persist` | covered |
+| `GET /v1/admin/plans/{subtree}` | Admin | `admin_plan` | covered |
+| `PUT /v1/admin/plans/{subtree}` | Admin | `admin_set_plan` | covered |
+| `GET /v1/admin/ready` | Admin | `ready` | covered |
+| `GET /v1/admin/retention` | Admin | `retention_status` | covered |
+| `DELETE /v1/admin/retention/policies` | Admin | `retention_policy_delete` | covered |
+| `GET /v1/admin/retention/policies` | Admin | `retention_policy_get` | covered |
+| `PUT /v1/admin/retention/policies` | Admin | `retention_policy_set` | covered |
+| `POST /v1/admin/retention/sweep` | Admin | `retention_sweep` | covered |
+| `GET /v1/admin/rollups/status` | Rollups | `admin_rollups_status` | covered |
+| `POST /v1/admin/scopes/migrate` | Admin | `admin_scope_migrate` | covered |
+| `GET /v1/admin/scopes/migrate/{id}` | Admin | `admin_scope_migration` | covered |
+| `GET /v1/admin/usage` | Admin | `admin_usage` | covered |
+| `GET /v1/admin/usage/subtrees` | Admin | `admin_usage_subtrees` | covered |
+| `POST /v1/admin/vector-hygiene` | Admin | `admin_vector_hygiene` | covered |
+| `GET /v1/admin/version` | Admin | `version` | covered |
+| `GET /v1/admin/wal` | Admin | `wal_status` | covered |
+| `POST /v1/admin/wal/compact` | Admin | `wal_compact` | covered |
+| `POST /v1/answer` | Read | `answer`, `answer_stream` | covered |
+| `GET /v1/apps/{id}` | Applications | `app_get` | covered |
+| `PUT /v1/apps/{id}` | Applications | `app_put` | covered |
+| `GET /v1/audit` | Audit | `audit_list` | covered |
+| `GET /v1/audit/chain` | Audit | `audit_chain` | covered |
+| `POST /v1/audit/chain/verify` | Audit | `audit_chain_verify` | covered |
+| `POST /v1/audit/verify` | Audit | `audit_verify` | covered |
+| `GET /v1/audit/{id}` | Audit | `audit_get` | covered |
+| `POST /v1/auth/revoke` | Auth | `revoke_token` | covered |
+| `POST /v1/auth/signup` | Auth | `signup` | covered |
+| `POST /v1/auth/tokens` | Auth | `mint_agent_token`, `mint_app_token`, `mint_token` | covered |
+| `GET /v1/auth/whoami` | Auth | `whoami` | covered |
+| `GET /v1/beliefs` | Layers | `beliefs` | covered |
+| `POST /v1/beliefs` | Layers | `create_belief` | covered |
+| `POST /v1/beliefs/build` | Layers | `build_beliefs` | covered |
+| `GET /v1/beliefs/history` | Layers | `belief_history` | covered |
+| `GET /v1/beliefs/why` | Layers | `belief_why` | covered |
+| `POST /v1/blobs` | Blobs | `upload_blob` | covered |
+| `DELETE /v1/blobs/idempotent` | Blobs | `retire_blob_keyed` | covered |
+| `POST /v1/blobs/idempotent` | Blobs | `upload_blob_keyed` | covered |
+| `GET /v1/blobs/idempotent/status` | Blobs | `blob_keyed_status` | covered |
+| `DELETE /v1/blobs/{id}` | Blobs | `delete_blob` | covered |
+| `GET /v1/blobs/{id}` | Blobs | `get_blob` | covered |
+| `GET /v1/claims` | Layers | `query_claims` | covered |
+| `GET /v1/claims/history` | Layers | `claim_history` | covered |
+| `GET /v1/code/calls` | Code plane | `code.calls` | covered |
+| `POST /v1/code/certify` | Code plane | `code.certify` | covered |
+| `POST /v1/code/context` | Code plane | `code.context` | covered |
+| `GET /v1/code/coverage/status` | Code plane | `code.coverage_status` | covered |
+| `GET /v1/code/export-index` | Code plane | `code.export_index` | covered |
+| `POST /v1/code/gc` | Code plane | `code.gc` | covered |
+| `POST /v1/code/graph/export` | Code plane | `code.graph_export` | covered |
+| `POST /v1/code/graph/query` | Code plane | `code.graph_query` | covered |
+| `GET /v1/code/history/for-symbol` | Code plane | `code.history_for_symbol` | covered |
+| `GET /v1/code/impact` | Code plane | `code.impact` | covered |
+| `POST /v1/code/import-index` | Code plane | `code.import_index` | covered |
+| `POST /v1/code/import/coverage` | Code plane | `code.import_coverage` | covered |
+| `POST /v1/code/import/scip` | Code plane | `code.import_scip` | covered |
+| `POST /v1/code/inventory` | Code plane | `code.inventory` | covered |
+| `GET /v1/code/matrix` | Code plane | `code.matrix` | covered |
+| `DELETE /v1/code/pins` | Code plane | `code.unpin` | covered |
+| `POST /v1/code/pins` | Code plane | `code.pin` | covered |
+| `GET /v1/code/repos` | Code plane | `code.repos` | covered |
+| `POST /v1/code/repos` | Code plane | `code.register_repo` | covered |
+| `DELETE /v1/code/repos/{name}` | Code plane | `code.remove_repo` | covered |
+| `GET /v1/code/repos/{name}` | Code plane | `code.repo_status` | covered |
+| `GET /v1/code/symbol/resolve` | Code plane | `code.resolve_symbol` | covered |
+| `GET /v1/code/symbol/search` | Code plane | `code.search_symbols` | covered |
+| `GET /v1/code/tests/for-change` | Code plane | `code.tests_for_change` | covered |
+| `POST /v1/code/workspace/context` | Code plane | `code.workspace_context` | covered |
+| `POST /v1/cohort/query` | Cohort (xscope) | `cohort_query` | covered |
+| `GET /v1/cohort/vocabulary` | Cohort (xscope) | `cohort_vocabulary` | covered |
+| `POST /v1/compose` | Read | `compose` | covered |
+| `GET /v1/concepts` | Layers | `concepts` | covered |
+| `GET /v1/concepts/coverage` | Layers | `concepts_coverage` | covered |
+| `GET /v1/concepts/{id}` | Layers | `concept` | covered |
+| `GET /v1/concepts/{id}/history` | Layers | `concept_history` | covered |
+| `GET /v1/concepts/{id}/related` | Layers | `concept_related` | covered |
+| `GET /v1/conflicts` | Layers | `list_conflicts` | covered |
+| `GET /v1/conflicts/{id}` | Layers | `get_conflict` | covered |
+| `POST /v1/conflicts/{id}/resolve` | Layers | `resolve_conflict` | covered |
+| `GET /v1/derivation/status` | Layers | `derivation_status` | covered |
+| `GET /v1/directory` | Directory | `directory_search` | covered |
+| `DELETE /v1/directory/{id}` | Directory | `directory_delete` | covered |
+| `GET /v1/directory/{id}` | Directory | `directory_get` | covered |
+| `PUT /v1/directory/{id}` | Directory | `directory_put` | covered |
+| `GET /v1/episodes` | Layers | `episodes` | covered |
+| `POST /v1/episodes/build` | Layers | `build_episodes` | covered |
+| `POST /v1/erasures` | Erasures | `erase` | covered |
+| `POST /v1/erasures/person` | Erasures | `erase_person` | covered |
+| `POST /v1/erasures/preview` | Erasures | `erasure_preview` | covered |
+| `POST /v1/erasures/tenant` | Erasures | `erase_tenant` | covered |
+| `GET /v1/erasures/{id}` | Erasures | `erasure_status` | covered |
+| `POST /v1/erasures/{id}/cancel` | Erasures | `erasure_cancel` | covered |
+| `GET /v1/erasures/{id}/receipt` | Erasures | `erasure_receipt` | covered |
+| `GET /v1/erasures/{id}/verify` | Erasures | `erasure_verify` | covered |
+| `GET /v1/events` | Layers | `events` | covered |
+| `GET /v1/events/{id}` | Layers | `event` | covered |
+| `POST /v1/experience` | Write | `experience` | covered |
+| `POST /v1/experience/bulk` | Write | `experience_bulk` | covered |
+| `POST /v1/experience/resume` | Write | `native.capture_resume` | covered |
+| `GET /v1/experience/status` | Write | `write_status` | covered |
+| `POST /v1/experience/status` | Write | `native.capture_status` | covered |
+| `POST /v1/experiences` | Write | `experience_bulk` | covered |
+| `POST /v1/export` | Import and export | `export`, `import_data` | covered |
+| `GET /v1/facts` | Layers | `facts` | covered |
+| `GET /v1/facts/timeline` | Layers | `facts_timeline` | covered |
+| `GET /v1/facts/{id}` | Layers | `fact` | covered |
+| `POST /v1/forget` | Forget | `forget` | covered |
+| `POST /v1/forget/preview` | Forget | `forget_preview` | covered |
+| `GET /v1/health` | Service and policy | `health` | covered |
+| `POST /v1/import` | Import and export | `import_data` | covered |
+| `POST /v1/import/jsonl` | Import and export | `import_jsonl` | covered |
+| `POST /v1/import/letta` | Import and export | `import_letta` | covered |
+| `POST /v1/import/mem0` | Import and export | `import_mem0` | covered |
+| `POST /v1/import/openai` | Import and export | `import_openai` | covered |
+| `POST /v1/import/zep` | Import and export | `import_zep` | covered |
+| `GET /v1/import/{id}` | Import and export | `import_status` | covered |
+| `GET /v1/lifecycle` | Lifecycle | `lifecycle_events` | covered |
+| `GET /v1/lifecycle/event/{lce_id}` | Lifecycle | `lifecycle_event` | covered |
+| `GET /v1/lifecycle/memory-event/{evt_id}` | Lifecycle | `lifecycle_memory_event` | covered |
+| `POST /v1/lifecycle/memory-event/{evt_id}/cancel` | Lifecycle | `cancel_event` | covered |
+| `GET /v1/lifecycle/stream` | Lifecycle | `lifecycle_stream` | covered |
+| `POST /v1/memory/commitments/commands` | Native memory host | `native.commitment_command` | covered |
+| `POST /v1/memory/commitments/current` | Native memory host | `native.commitment_current` | covered |
+| `POST /v1/memory/commitments/evidence` | Native memory host | `native.commitment_evidence` | covered |
+| `POST /v1/memory/commitments/status` | Native memory host | `native.commitment_status` | covered |
+| `POST /v1/memory/source-erasure/commands` | Native memory host | `native.source_erasure_command` | covered |
+| `POST /v1/memory/source-erasure/discovered-commands` | Native memory host | `native.source_erasure_discovered_command` | covered |
+| `POST /v1/memory/source-erasure/discovery` | Native memory host | `native.source_erasure_discovery` | covered |
+| `POST /v1/memory/source-erasure/progress` | Native memory host | `native.source_erasure_progress` | covered |
+| `POST /v1/memory/source-erasure/refusals` | Native memory host | `native.source_erasure_refusal` | covered |
+| `POST /v1/memory/source-erasure/status` | Native memory host | `native.source_erasure_status` | covered |
+| `GET /v1/openapi.json` | Service and policy | `openapi` | covered |
+| `GET /v1/plan` | Service and policy | `plan` | covered |
+| `GET /v1/policy/deployment` | Service and policy | `policy_deployment` | covered |
+| `GET /v1/policy/effective` | Service and policy | `policy_effective` | covered |
+| `POST /v1/publish` | Publish | `publish` | covered |
+| `GET /v1/ready` | Service and policy | `ready` | covered |
+| `POST /v1/recall` | Read | `recall` | covered |
+| `POST /v1/recall/stream` | Read | `recall_stream` | covered |
+| `GET /v1/rollups` | Rollups | `rollups` | covered |
+| `GET /v1/rollups/totals` | Rollups | `rollup_totals` | covered |
+| `GET /v1/rollups/{id}` | Rollups | `rollup` | covered |
+| `GET /v1/schemas` | Service and policy | `schemas` | covered |
+| `GET /v1/schemas/{name}` | Service and policy | `schema` | covered |
+| `DELETE /v1/scopes` | Scopes | `scope_delete` | covered |
+| `GET /v1/scopes` | Scopes | `scope_get` | covered |
+| `POST /v1/scopes` | Scopes | `scope_register` | covered |
+| `GET /v1/scopes/list` | Scopes | `scopes_list` | covered |
+| `PUT /v1/scopes/members` | Scopes | `scope_set_members` | covered |
+| `POST /v1/scopes/prune` | Scopes | `scopes_prune` | covered |
+| `PUT /v1/scopes/tree` | Scopes | `scope_set_tree` | covered |
+| `GET /v1/temporal/phrases` | Vocabularies and phrases | `temporal_phrases` | covered |
+| `POST /v1/temporal/phrases` | Vocabularies and phrases | `add_temporal_phrase` | covered |
+| `DELETE /v1/temporal/phrases/{name}` | Vocabularies and phrases | `delete_temporal_phrase` | covered |
+| `GET /v1/understanding` | Layers | `understanding` | covered |
+| `GET /v1/understanding/coverage` | Layers | `concepts_coverage` | covered |
+| `POST /v1/understanding/synthesize` | Layers | `synthesize` | covered |
+| `GET /v1/understanding/synthesize/{id}` | Layers | `synthesis_status` | covered |
+| `GET /v1/understanding/{id}` | Layers | `concept` | covered |
+| `GET /v1/understanding/{id}/history` | Layers | `understanding_history` | covered |
+| `GET /v1/understanding/{id}/related` | Layers | `concept_related` | covered |
+| `GET /v1/usage` | Service and policy | `usage` | covered |
+| `GET /v1/vocabularies` | Vocabularies and phrases | `vocabularies` | covered |
+| `POST /v1/vocabularies` | Vocabularies and phrases | `create_vocabulary` | covered |
+| `DELETE /v1/vocabularies/{name}` | Vocabularies and phrases | `delete_vocabulary` | covered |
+| `GET /v1/vocabularies/{name}` | Vocabularies and phrases | `vocabulary` | covered |
+| `PATCH /v1/vocabularies/{name}` | Vocabularies and phrases | `update_vocabulary` | covered |
+| `PUT /v1/vocabularies/{name}` | Vocabularies and phrases | `replace_vocabulary` | covered |
+
+## Fields, headers and errors of 0.14.0
+
+| Family | Where | SDK | Status |
+|---|---|---|---|
+| `consistency: {}` / `{"at_least": token}` (`consistency_tokens_v1`) | `/v1/recall`, `/v1/recall/stream`, `/v1/answer`, `/v1/compose`, `POST /v1/access/{check,explain,lookup/scopes,lookup/principals}` | `consistency=True` or `consistency=<token>` | covered |
+| `?consistency=1` | `POST /v1/experience`, `/v1/experience/bulk`, `/v1/experiences`, `POST /v1/scopes`, `PUT /v1/scopes/{members,tree}`, `DELETE /v1/scopes` | `consistency=True` | covered on the write routes |
+| `?at_least=<token>` | `GET /v1/events`, `/v1/events/{id}`, the fact, belief, episode and concept reads, `GET /v1/scopes`, `GET /v1/experience/status` | `at_least=<token>` | covered on the routes the SDK reaches |
+| `consistency_token`, `consistency_reset`, `derived_through`, `access_restored_at` in responses | every route above | typed in `cortexdb.v1.models`; `ConsistencyTokens` records them per root | covered |
+| `extra_scopes` (up to 40, `extra_scopes_40_v1`) | `/v1/recall`, `/v1/recall/stream`, `/v1/answer`, `/v1/compose` | `extra_scopes=[...]` (more than 40 is a `ValueError` before the call) | covered |
+| `coverage: true` (`recall_coverage_v1`) | the same four routes | `coverage=True`; `Coverage` in `cortexdb.v1.models` | covered |
+| `beliefs: "merged"` (`beliefs_merged_v1`) | the same four routes; `GET /v1/beliefs/why` `merges`, `scopes`, `scope` | `beliefs="merged"`; `belief_why(..., merges=, scopes=, scope=)` | covered |
+| `mounts: "default"` (`recall_mounts_v1`) | the same four routes | `mounts="default"` | covered |
+| `provenance` (`write_provenance_v1`) | `POST /v1/experience`, each `/v1/experience/bulk` and `/v1/experiences` item, `/v1/import/jsonl` lines, `POST /v1/beliefs` | `provenance=[...]` on `experience`, a bulk item's `"provenance"`, a JSONL line's own field, `create_belief(..., provenance=)` | covered |
+| The read-free forget (`forget_by_key_v1`): `selector.idempotency_keys`, `selector.capture_keys` | `POST /v1/forget`, `/v1/forget/preview` | `idempotency_keys=[key or (key, caller)]`, `capture_keys=[label]` | covered |
+| `subject: {email}` with `confirm: true` (`party_erasure_v1`) | `POST /v1/erasures`, `/v1/erasures/preview` | `erase(root, subject_email=..., confirm=True)`, `erasure_preview(root, subject_email=...)` | covered |
+| Server-sent events: `plan`, `layer`, `context_block`, `token`, `citations`, `done`, `error` | `/v1/recall/stream`, `/v1/answer` with `stream: true`, `/v1/lifecycle/stream` | `recall_stream`, `answer_stream`, `lifecycle_stream` yield `StreamEvent`s (async iterators on `AsyncV1Client`); an `error` event raises | covered |
+| `X-Cortex-Break-Glass: reason=…; ticket=…[; note=…]` (`operator_break_glass_v1`) | every operator-key request under `CORTEX_OPERATOR_DATA_READS=deny`, the tenant's or the deployment's | `client.break_glass(reason, ticket, note)`, `with_options(break_glass=...)`; `break_glass_header` checks the form | covered |
+| `X-Cortex-Subject-Token` (`subject_token_shadow_v1`) | the trusted operator's requests | `with_options(subject_token=...)` | covered |
+| Chain fields of a mint (`act`, `app`, `client`, `run`, `run_start`, `taint`; `mint_chain_v1`) and `tenant` | `POST /v1/auth/tokens` | `mint_token(...)`, `mint_agent_token`, `mint_app_token`; `check_mint` refuses locally what the server always refuses; `with_token` | covered |
+| `purpose` (`read_purpose_v1`) | `/v1/recall`, `/v1/recall/stream`, `/v1/answer`, `/v1/compose`, `POST /v1/access/{check,explain}` | `purpose="..."` (`[a-z0-9_-]{1,64}`, a `ValueError` otherwise); a read refused for want of its purpose raises `PolicyDeniedError` with `reason == "purpose_required"` and `purpose` | covered |
+| `?scope=` on the by-id reads (a scope that does not hold the row is 404) | `/v1/facts/{id}`, `/v1/beliefs/{why,history}`, `/v1/concepts/{id}[/history,/related]`, `/v1/understanding/{id}[/history,/related]`, `/v1/conflicts/{id}[/resolve]`, `/v1/lifecycle/event/{id}`, `/v1/admin/events/{id}/chunks`, `/v1/erasures/{id}[/receipt,/verify]` | `scope=` | covered |
+| `include_vectors=true` | the layer listings and the fact and concept reads by id | `include_vectors=True` | covered |
+| Paging: `cursor` / `next_cursor` / `has_more` (the events' `le1.` cursor newest first, the scope list, the layers) | `GET /v1/events`, `/v1/scopes/list`, `/v1/facts`, `/v1/beliefs`, `/v1/episodes`, `/v1/understanding`, `/v1/concepts` and the access listings | `cursor=`, `pages(method, ...)` | covered |
+| `as_of` on the timeline; `?at_least=` and the token on `GET /v1/access/records`; `?consistency=1` on `POST /v1/publish` | those routes | `as_of=`, `at_least=`, `consistency=True` | covered |
+| `idempotency_key` on a declared belief; `owner` on `POST /v1/scopes`; `scope` on a temporal phrase; `batch_id` on the lifecycle stream | those routes | `idempotency_key=`, `owner=`, `scope=`, `batch_id=` | covered |
+| `events_under_legal_hold`, `derived_under_legal_hold`, and `matched` counting what a hold kept | `POST /v1/forget`, `/v1/forget/preview` | in the answer (documented on both methods) | covered |
+| `in_band`, `in_band_parts` of a change set's preview; the operator key's in-band activation under `deny` (`BREAK_GLASS_REQUIRED` class `in_band`, `NOTICE_UNAVAILABLE`, `REGISTRY_STALE`) | `POST /v1/access/changes/{id}/preview`, `/activate` | `ChangeSetPreview` in `cortexdb.v1.models`; `client.break_glass(...).changeset_activate(...)` | covered |
+| A change set's 202 while its evaluation runs (0.14.1; `Retry-After`, a preview's `{state: "previewing"}`) | `POST /v1/access/changes`, `/{id}/parts`, `/{id}/preview`, `/{id}/activate` | sent again after `Retry-After` for at most `wait` seconds (`CHANGESET_WAIT_SECONDS`), then `V1EvaluationPendingError`; `wait=0` returns `EvaluationPending` | covered |
+| `operator_plane` of a tenant binding, its dry run's included (0.14.1) | `POST /v1/admin/access/tenant-binding` | `TenantBindingResponse` in `cortexdb.v1.models`; `admin_tenant_binding` | covered |
+| `deployment_mode` (`tenant_access_settings_v1`) | `GET`, `PUT /v1/admin/access/tenant-settings`; the access report's `tenant_settings` | `TenantAccessSettings` in `cortexdb.v1.models` | covered |
+| `resend` of a write status (`"no"` for a failed write, never re-sent; `"new_key"` gone) | `GET /v1/experience/status` | `write_status(...)`; `IndexingFailedError` says never to re-send | covered |
+| An omitted `X-Cortex-Actor` (issuers-file `prefix`, `hash` and `directory` tokens; SCIM clients) | every route | `actor=None`, `with_options(actor=None)`; derived from a token's `sub` when no `actor` is given (none for a mapped subject) | covered |
+| `view` left to the server (granular at an org tree's shared scope) | `/v1/recall`, `/v1/answer`, `/v1/compose` | `view=None` (the default) | covered |
+| Typed errors with `retriable` and `details` | every route | one class per code (`cortexdb.v1.errors`, 363 codes from `scripts/error_codes.json`, built from the error catalog, `docs/API_REFERENCE_V1.md` §16) under status-family classes; documented `details` keys as properties; `retry_after` | covered |