definition
definition
Section titled “definition”| Field | Value |
|---|---|
| Prefix | definition |
| Namespace constant | DefinitionNamespace |
| Subjects constant | DefinitionSubjects |
| Kind | bus |
| Schema record | DefinitionSchemas |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/definition/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
getConfigSchema | definition.getConfigSchema | rpc | schemas.ts |
getCredentialSchema | definition.getCredentialSchema | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”definition.getConfigSchema (rpc)
Section titled “definition.getConfigSchema (rpc)”Get the JSON Schema for a provider definition’s config fields.
Subject: definition.getConfigSchema
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
definitionId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
hasSchema | boolean | yes |
schema | Record<string, unknown> | null | yes |
definition.getCredentialSchema (rpc)
Section titled “definition.getCredentialSchema (rpc)”Get the JSON Schema for a provider definition’s credential fields.
Subject: definition.getCredentialSchema
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
definitionId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
hasSchema | boolean | yes |
schema | Record<string, unknown> | null | yes |
Auto-generated by yarn docs:bus. Do not edit manually.