Skip to content

machinefabric/capfab

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CapFab

Standard capability and media definitions for the CAPDAG system.

CapFab is the canonical reference of what operations exist in the MachineFabric ecosystem and what data types they consume and produce. The definitions in standard/ drive the live capdag.com registry.

Contributing

Anyone can propose a new capability or media def. As long as a definition is well-formed, fills a real gap in the registry, and is documented clearly enough that other people can use it, we'll happily review and accept it. If you're unsure about any part of a submission, send it anyway and we'll work it out together.

To do this Open an issue using this template
Add a new capability or media def Add Definition
Report a bug, ask a question, propose a feature Feedback on Definitions

Submissions are paste-the-JSON. Browse standard/ and standard/media/ for live examples of what we accept; the schemas are at cap.schema.json and media.schema.json.

We curate every submission by hand. There's no automated merge — a maintainer will read your issue, work with you on any rough edges, and once we're happy with the shape, the new definition appears here and on capdag.com.

Layout

capfab/
├── cap.schema.json               JSON schema for capability definitions
├── media.schema.json             JSON schema for media definitions
└── standard/
    ├── *.json                    one file per capability
    ├── all-capabilities.json     combined manifest of every capability
    └── media/
        ├── *.json                one file per media def
        └── all-media-defs.json  combined manifest of every media def

Each capability JSON describes a single operation: its URN tags (notably in and out media URNs), its title and description, and any structured arguments it accepts. Each media def describes a media URN's shape — its content type, profile, and any associated documentation.

Using these definitions in code

Capability and media URNs are tagged URNs with directional matching semantics; they should be parsed and compared via the capdag library, never by string. The FabricRegistryClient in that library loads and resolves both cap definitions and media defs through the unified registry.

Part of MachineFabric

CapFab is part of the MachineFabric project.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors