162-capability-catalog

Every operation is described once, and the description is tested

Lifecycle approvedImplementation completeVerification unknownQualification unknown

Adds a versioned, canonical, digest-bearing capability catalog compiled into the binary: every CLI and facade operation with its summary, schema references, exact effects, preconditions, exit outcomes, budgets, pagination, stability, deprecation and examples. The catalog rides the one `capabilities` answer spec 170 established, as an additive member, so a binary still states what it supports through one path. Census tests hold it to the clap tree, the facade, the verdict verbs and the managed gate; the examples run against the built binary. `capabilities verify` checks pinned operation digests. The catalog describes; it authorizes nothing.

Read the full pinned specification ↗

Relationships

Claimed units

  • establishes
    {
      "kind": "file",
      "path": "crates/spec-spine-types/src/capability.rs"
    }
  • establishes
    {
      "kind": "file",
      "path": "crates/spec-spine-types/schemas/capability-catalog.schema.json"
    }
  • establishes
    {
      "kind": "file",
      "path": "crates/spec-spine-core/src/capability.rs"
    }
  • establishes
    {
      "kind": "file",
      "path": "crates/spec-spine-core/tests/capability_catalog.rs"
    }
  • establishes
    {
      "kind": "file",
      "path": "crates/spec-spine-cli/tests/capability_catalog.rs"
    }
  • establishes
    {
      "kind": "directory",
      "path": "crates/spec-spine-cli/tests/fixtures/capability-catalog/"
    }
  • establishes
    {
      "anchor": "the-capability-catalog",
      "file": "docs/capability-catalog.md",
      "kind": "section"
    }
  • extends
    {
      "nature": "additive",
      "spec": "001-compile-registry",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-types/src/lib.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "074-a-governed-read-names-its-version",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-types/src/version.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "022-index-sharding",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-types/src/schema.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "034-machine-readable-verdicts",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-types/src/verdict.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "170-a-consumer-is-served-answers-not-access",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-types/src/capabilities.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "001-compile-registry",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-core/src/lib.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "002-registry-query",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-cli/src/main.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "170-a-consumer-is-served-answers-not-access",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-cli/src/cmd_capabilities.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "170-a-consumer-is-served-answers-not-access",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-cli/tests/capabilities.rs"
      }
    }
  • extends
    {
      "nature": "corrective",
      "spec": "110-an-interface-reference-is-digest-pinned",
      "unit": {
        "kind": "file",
        "path": "crates/spec-spine-cli/src/cmd_interface.rs"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "057-the-docs-name-what-adopters-derived",
      "unit": {
        "kind": "file",
        "path": "docs/api.md"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "057-the-docs-name-what-adopters-derived",
      "unit": {
        "anchor": "cli-reference",
        "file": "docs/cli-reference.md",
        "kind": "section"
      }
    }
  • extends
    {
      "nature": "additive",
      "spec": "057-the-docs-name-what-adopters-derived",
      "unit": {
        "kind": "file",
        "path": "docs/schema-versioning.md"
      }
    }

Source headings

  1. 162: Every operation is described once, and the description is tested
  2. 1. Purpose
  3. 2. Territory
  4. 3. Behavior
  5. 3.1 One catalog, one definition per operation
  6. 3.2 Operation names
  7. 3.3 The operation record
  8. 3.4 Effects are declared exactly
  9. 3.5 Preconditions and outcomes
  10. 3.6 Request and response schemas and versions
  11. 3.7 Budgets and pagination
  12. 3.8 Stability, deprecation and compatibility
  13. 3.9 Examples run against the built binary
  14. 3.10 The catalog is held to the code
  15. 3.11 Digests, discovery and verification
  16. 3.12 The verb, the facade and the exit contract
  17. 3.13 Determinism and the schema axis
  18. 3.14 Trust boundary
  19. 3.15 Inventory
  20. 4. Acceptance criteria
  21. 5. Out of scope
  22. 6. Resolved decisions
  23. Verification

Frozen anchors

No frozen anchors declared.