capability
capability
Section titled “capability”| Field | Value |
|---|---|
| Prefix | capability |
| Namespace constant | CapabilityNamespace |
| Subjects constant | CapabilitySubjects |
| Kind | bus |
| Schema record | CapabilitySchemas |
| Tier | framework |
| Package | @makaio/contracts |
| Defined in | packages/contracts/src/capability/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
listProviders | capability.listProviders | rpc | schemas.ts |
register | capability.register | event | schemas.ts |
unregister | capability.unregister | event | schemas.ts |
validate | capability.validate | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”capability.listProviders (rpc)
Section titled “capability.listProviders (rpc)”List all providers for a capability.
Subject: capability.listProviders
Type: Request (RPC)
Purpose: Returns all registered providers for a given capability.
Request:
| Field | Type | Required |
|---|---|---|
capabilityId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
providers | { id: string; displayName: string; providerKey?: string | undefined; }[] | yes |
capability.register (event)
Section titled “capability.register (event)”Register a capability provider.
Subject: capability.register
Type: Event (fire-and-forget)
Purpose: Plugins emit this to register their capability providers.
| Field | Type | Required |
|---|---|---|
capabilityId | string | yes |
provider | unknown | yes |
capability.unregister (event)
Section titled “capability.unregister (event)”Unregister a capability provider.
Subject: capability.unregister
Type: Event (fire-and-forget)
Purpose: Plugins emit this to remove providers that are no longer available.
| Field | Type | Required |
|---|---|---|
capabilityId | string | yes |
providerId | string | yes |
capability.validate (rpc)
Section titled “capability.validate (rpc)”Validate all providers for a capability.
Subject: capability.validate
Type: Request (RPC)
Purpose: Validates all providers for a capability and returns results.
Request:
| Field | Type | Required |
|---|---|---|
capabilityId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
results | { id: string; valid: boolean; error?: string | undefined; }[] | yes |
Auto-generated by yarn docs:bus. Do not edit manually.