Capability Registry API: schemas

The request and response bodies of the operations in this API.

ActionCatalogKind

Type: one of "capability", "workflow", "function"

CapabilityDescriptorBindingDto

PropertyTypeRequiredDescription
expectedDescriptorHashstringyesLowercase sha256 hex of the descriptor: the capability record's descriptorHash when it was picked.
refstringyes

CapabilityProviderBindingDto

PropertyTypeRequiredDescription
capabilityRefstringyesCanonical capability ref this binding backs.
createdAtstringyes
credentialBindingIdstringnoOpaque credential-binding id resolved by the credential-broker. Absent ⇒ the backing needs no brokered secret. Never a secret.
idstringyes
isDefaultbooleanyesWhether this binding is the org's default for the ref. At most one default per (orgId, capabilityRef).
orgIdstringyesTenant org this binding is scoped to.
providerConfigobjectyesTransport-specific config (e.g. { url } for http_endpoint). Never a secret.
providerKindone of "model_modality", "http_endpoint", "worker", "integration", "platform_service"yes
readinessProviderBindingReadinessDtoyesWhether the binding can serve an invocation now, derived at read time. Non-integration bindings are always ready.
targetCapabilitiesarray of stringyesCapabilities the binding's target needs of its own to serve the ref (e.g. credential:resolve@1 for a connector operation that reads its connection's credential). A delegated caller lends them separately and the target is lent exactly these. Empty ⇒ the target needs nothing.
updatedAtstringyes

CapabilityProviderBindingDtoDataEnvelope

PropertyTypeRequiredDescription
dataCapabilityProviderBindingDtoyes

CapabilityProviderBindingListDto

PropertyTypeRequiredDescription
bindingsarray of CapabilityProviderBindingDtoyes

CapabilityProviderBindingListDtoDataEnvelope

PropertyTypeRequiredDescription
dataCapabilityProviderBindingListDtoyes

CreateCapabilityProviderBindingDto

PropertyTypeRequiredDescription
capabilityRefstringyes
credentialBindingIdstringnoOpaque credential-binding id. Never a secret.
isDefaultbooleannoMark this binding as the org's default for the ref. Defaults to false.
providerConfigobjectyesTransport config. Never a secret.
providerKindone of "model_modality", "http_endpoint", "worker", "integration", "platform_service"yes
targetCapabilitiesarray of stringnoCapabilities the binding's target needs of its own to serve the ref (e.g. credential:resolve@1 for a connector operation that reads its connection's credential). A delegated caller lends them separately and the target is lent exactly these. Empty ⇒ the target needs nothing.

CreateHookBindingDto

PropertyTypeRequiredDescription
executeAsSubjectRefDtoyesKernel SubjectRef the handler executes as: the creator themself, or the organization when an administrator creates the binding in the org Space.
handlerHookHandlerRefDtoyesThe action kind and the exact capability descriptor: its ref and the capability record's current descriptorHash.
hookPointIdstringyes
modeHookModeyes
parametersobjectnoTyped configuration for the handler, passed to it with every invocation. The handler declares their schema (the parameters property of its capability's input schema); a binding whose parameters that schema refuses, or whose handler declares none, is refused (parameters-invalid, parameters-not-declared). Absent means none.
participationHookParticipationyes
projectionarray of stringyesThe approved input projection (field pointers).
spaceSpaceRefDtoyesThe Space the binding is scoped to: the caller's org Space or their own user Space.

DataClassification

Type: one of "public", "internal", "confidential", "secret", "regulated"

HookBindingAction

What this caller may do to the binding, judged by the same authority the mutating route applies. Empty means read-only.

Type: one of "remove", "remove-required"

HookBindingAuthority

How far the execute delegation got: awaiting (not served), provisioning, authorized, or ended (served; fails closed until re-authorized). A read model for authors; execution never trusts it.

Type: one of "awaiting", "provisioning", "authorized", "ended"

HookBindingAuthorityRefusal

Why the last attempt did not promote the binding.

Type: one of "requires-member", "owner-unreachable", "origination-refused", "delegation-ended", "owner-changed"

HookBindingConflictCode

SCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.

Type: one of "HOOK_BINDING_CONTENTION", "HOOK_BINDING_NOT_REQUIRED", "HOOK_BINDING_REQUIRED_NEEDS_POLICY_REMOVAL"

HookBindingConflictProblemDto

RFC 9457 problem document of a hook binding route. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeHookBindingConflictCodeyesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
contentionHookBindingContentionCausenoPresent on HOOK_BINDING_CONTENTION: why the write lost.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
retryablebooleannoTrue on HOOK_BINDING_CONTENTION: the write was rolled back whole; send it again.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

HookBindingContentionCause

Present on HOOK_BINDING_CONTENTION: why the write lost.

Type: one of "deadlock", "serialization-failure"

HookBindingDormancyDto

PropertyTypeRequiredDescription
causeHookBindingDormantCauseyes
codesarray of HookBindingRefusalCodeyesThe admission codes a refusing declaration raised (declaration-refused); empty for every other cause.

HookBindingDormantCause

Type: one of "execute-as-organization-on-session-point", "declaration-withdrawn", "declaration-refused", "descriptor-withdrawn"

HookBindingDto

PropertyTypeRequiredDescription
authorityHookBindingAuthorityyesHow far the execute delegation got: awaiting (not served), provisioning, authorized, or ended (served; fails closed until re-authorized). A read model for authors; execution never trusts it.
authorityRefusalHookBindingAuthorityRefusalnoWhy the last attempt did not promote the binding.
authorityUpstreamCodestringnoThe authorization-api code behind an origination-refused.
availableActionsarray of HookBindingActionyesWhat this caller may do to the binding, judged by the same authority the mutating route applies. Empty means read-only.
bindingIdstringyes
dormancyHookBindingDormancyDto or nullyesNon-null exactly when state is dormant.
executeAsSubjectRefDtoyes
handlerHookHandlerRefDtoyes
hookPointIdstringyes
modeHookModeyes
orgIdstringyesThe org the binding was admitted in.
originHookBindingOriginyesauthored in the registry by a member, or contributed by an installation.
parametersobjectnoThe handler's admitted parameters; absent means none.
participationHookParticipationyes
projectionarray of stringyes
revisionnumberyes
spaceSpaceRefDtoyes
stateHookBindingStateyesactive bindings are served to the owner; dormant ones are withheld, with dormancy saying why.

HookBindingDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookBindingDtoyes

HookBindingEffectiveEntryDto

PropertyTypeRequiredDescription
appliesbooleanyesTrue when the binding applies to operations in the viewed Space: active and not suppressed on the chain. This is the set the owner's composer evaluates.
bindingHookBindingDtoyes
inheritanceHookBindingInheritanceyesown when declared in the viewed Space; inherited when declared in an ancestor, which binding.space names.
readOnlybooleanyesTrue when this caller has no action at all on the entry: binding.availableActions and suppressionActions are both empty.
suppressedByarray of HookBindingSuppressionDtoyesThe suppressions on the chain that stop this binding applying here. Empty when it is not suppressed.
suppressionActionsarray of HookBindingSuppressionActionyesWhat this caller may do about the binding AT the viewed Space, judged by the same rules the suppression routes apply.

HookBindingEffectiveSetDto

PropertyTypeRequiredDescription
canCreatebooleanyesWhether this caller may create a binding in the viewed Space (the authority POST hook-bindings applies; admission of the body is separate).
entriesarray of HookBindingEffectiveEntryDtoyes
spaceSpaceRefDtoyes

HookBindingEffectiveSetDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookBindingEffectiveSetDtoyes

HookBindingForbiddenProblemDto

RFC 9457 problem document of a hook binding route. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeone of "HOOK_BINDING_SPACE_NOT_PERMITTED"yesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

HookBindingInheritance

own when declared in the viewed Space; inherited when declared in an ancestor, which binding.space names.

Type: one of "own", "inherited"

HookBindingListDto

PropertyTypeRequiredDescription
bindingsarray of HookBindingDtoyes

HookBindingListDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookBindingListDtoyes

HookBindingNotFoundCode

SCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.

Type: one of "HOOK_BINDING_NOT_FOUND", "HOOK_BINDING_SUPPRESSION_NOT_FOUND"

HookBindingNotFoundProblemDto

RFC 9457 problem document of a hook binding route. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeHookBindingNotFoundCodeyesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

HookBindingOrigin

authored in the registry by a member, or contributed by an installation.

Type: one of "contributed", "authored"

HookBindingRefusalCode

The admission codes a refusing declaration raised (declaration-refused); empty for every other cause.

Type: one of "hook-point-mismatch", "mode-not-declared", "action-kind-incompatible", "participation-not-allowed", "projection-outside-declaration", "ambient-execute-authority", "bindings-refused"

HookBindingRefusalReason

Every reason, never only the first: the kernel's admission codes and the registry's own.

Type: string (22 values)

HookBindingRefusedProblemDto

RFC 9457 problem document of a hook binding route. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeone of "HOOK_BINDING_REFUSED"yesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
refusalsarray of HookBindingRefusalReasonyesEvery reason, never only the first: the kernel's admission codes and the registry's own.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

HookBindingState

active bindings are served to the owner; dormant ones are withheld, with dormancy saying why.

Type: one of "active", "dormant"

HookBindingSuppressionAction

What this caller may do about the binding AT the viewed Space, judged by the same rules the suppression routes apply.

Type: one of "suppress", "unsuppress"

HookBindingSuppressionDto

PropertyTypeRequiredDescription
bindingIdstringyes
spaceSpaceRefDtoyes

HookBindingSuppressionDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookBindingSuppressionDtoyes

HookBindingSuppressionListDto

PropertyTypeRequiredDescription
suppressionsarray of HookBindingSuppressionDtoyes

HookBindingSuppressionListDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookBindingSuppressionListDtoyes

HookBindingSuppressionRequestDto

PropertyTypeRequiredDescription
bindingIdstringyes
spaceSpaceRefDtoyesThe Space (at or below the binding's) that suppresses it.

HookConcurrencyScope

What limits.maxConcurrency counts. Absent: tenant.

Type: one of "tenant", "lineage"

HookHandlerRefDto

PropertyTypeRequiredDescription
actionKindActionCatalogKindyes
descriptorCapabilityDescriptorBindingDtoyes

HookMode

Type: one of "admit", "transform", "defer", "respond"

HookModeDeclarationDto

PropertyTypeRequiredDescription
actionKindsarray of ActionCatalogKindyes
modeHookModeyes

HookParticipation

Type: one of "required", "optional"

HookPointBindingRefusal

Type: one of "lineage-unsealed"

HookPointBindingsRefusedDeclarationDto

PropertyTypeRequiredDescription
refusedHookPointBindingRefusalyes

HookPointDeclarationDto

PropertyTypeRequiredDescription
bindingsRefusedHookPointBindingsRefusedDeclarationDtonoPresent: the point admits no binding of any participation, for this reason.
concurrencyScopeHookConcurrencyScopenoWhat limits.maxConcurrency counts. Absent: tenant.
idstringyes
inputProjectionarray of stringyesThe widest input projection any binding may be approved for (field pointers).
limitsHookPointLimitsDtoyes
modesarray of HookModeDeclarationDtoyes
operationstringyesStable id of the owner's operation this point guards.
participationarray of HookParticipationyes
reentryHookReentryDeclarationDtonoAbsent: the point is never re-entered on its own synchronous chain.
respondHookRespondDeclarationDtonoPresent iff the point declares a respond mode.
writableFieldsarray of stringyesFields a transform may write (field pointers); empty unless a transform mode is declared.

HookPointLimitsDto

PropertyTypeRequiredDescription
deadlineMsnumberyesThe one overall deadline for an evaluation, in milliseconds.
maxConcurrencynumberyesMaximum handlers in flight at once for one evaluation.
maxFanOutnumberyesMaximum bindings fanned out per evaluation.
maxPayloadBytesnumberyesMaximum bytes of one receiver's input projection.

HookPointListDto

PropertyTypeRequiredDescription
hookPointsarray of HookPointSummaryDtoyes

HookPointListDtoDataEnvelope

PropertyTypeRequiredDescription
dataHookPointListDtoyes

HookPointSummaryDto

PropertyTypeRequiredDescription
declarationHookPointDeclarationDtoyes
serviceNamestringyesThe workload that declares the point.
withdrawnbooleanyesTrue once the owner no longer declares it.

HookReentryDeclarationDto

PropertyTypeRequiredDescription
maxDepthnumberyesMaximum enclosing evaluations of the point on one synchronous lineage.

HookRespondDeclarationDto

PropertyTypeRequiredDescription
maxResponseBytesnumberyesMaximum bytes of one response (UTF-8 JSON).
responseSchemaIdstringyesThe owner-named schema a response must satisfy.

HookScopeRefusalCode

Type: one of "required-binding-suppressed", "unknown-binding-suppressed"

HookScopeRefusalDto

PropertyTypeRequiredDescription
bindingIdstringyes
codeHookScopeRefusalCodeyes
spacestringyesThe suppressing Space, as its canonical xema:// URI.

HookScopeRefusedProblemDto

RFC 9457 problem document of a hook binding route. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeone of "HOOK_SCOPE_REFUSED"yesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
refusalsarray of HookScopeRefusalDtoyes
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

OrgRoleForbiddenProblemDto

RFC 9457 problem document of an org-role refusal. Extension members stay top-level and open, as on ProblemDetailsDto.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codeone of "ORG_ROLE_NOT_PERMITTED"yesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

ProblemActionableBy

Who can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.

Type: one of "user", "org-admin", "platform", "none"

ProblemDetailsDto

RFC 9457 problem document. The declared members are the reserved core; extension members are TOP-LEVEL and OPEN, owned by the refusing plane.

PropertyTypeRequiredDescription
actionableByProblemActionableBynoWho can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
codestringyesSCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name.
detailstringnoHuman-readable and specific to THIS occurrence.
errorsarray of ProblemFieldIssueDtonoField-level issues, when the refusal is about the request body.
instancestringnoURI reference identifying the occurrence — a request path, a run, a row.
paramsmap of string or number or booleannoSafe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics.
retryProblemRetrynoWhat a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
statusnumberyesThe HTTP status code, repeated in the body so a logged document is self-contained.
titlestringyesShort, human-readable, and STABLE for a given type. Never per-occurrence — that is detail.
traceIdstringnoW3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not.
typestringyesAbsolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank.

ProblemFieldIssueDto

PropertyTypeRequiredDescription
codestringnoSCREAMING_SNAKE_CASE code of THIS issue, for a frontend i18n key. Present when the issue was minted by a declared problem.
detailstringyesProse for logs and developers. A frontend localises from code + params instead.
paramsmap of string or number or booleannoSafe i18n interpolation values for this issue's code.
pointerstringyesRFC 6901 JSON Pointer into the request body. Root is "/".

ProblemRetry

What a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.

Type: one of "transient", "after-change", "never"

ProviderBindingNotReadyReasonDto

PropertyTypeRequiredDescription
codeone of "output-mapping-invalid", "output-schema-root-not-object", "capability-output-schema-missing", "capability-missing", "provider-config-invalid", "operation-missing", "operation-not-declarative", "operation-effect-exceeds-capability"yes
issuesarray of ProviderBindingOutputMappingIssueDtonoFor output-mapping-invalid: the mapping issues against the CURRENT outputSchema.

ProviderBindingOutputMappingIssueDto

PropertyTypeRequiredDescription
codeone of "target-undeclared", "target-duplicate", "target-overlap", "required-uncovered", "type-incompatible", "enum-incompatible", "each-target-not-array", "unmappable-schema"yes
entryPatharray of string or numberyesPath inside the mapping document.
messagestringyes
pointerstringyesThe offending target pointer.

ProviderBindingReadinessDto

PropertyTypeRequiredDescription
reasonsarray of ProviderBindingNotReadyReasonDtoyes
stateone of "ready", "not-ready"yes

RemoveRequiredHookBindingDto

PropertyTypeRequiredDescription
reasonstringyesWhy a REQUIRED binding is being removed. Recorded in the audit journal.

SpaceKind

The tier the binding is resolved FOR. Resolution walks UP from here, so a requirement declared at project is satisfied by an org binding. system, app and session are refused at the service seam: the first is a deployment invariant no tenant can act on, and the other two are runtime containers a binding must not outlive.

Type: one of "system", "org", "project", "app", "session", "biome", "user"

SpaceRefDto

PropertyTypeRequiredDescription
appIdstringno
biomeIdstringno
classificationDataClassificationno
orgIdstringno
pathstringnoThe canonical xema:// URI of this Space. Always present on a response; it is the value a space query parameter takes. Optional on a request.
projectIdstringno
sessionIdstringno
tierSpaceKindyes
userIdstringno

SubjectKind

Type: string (12 values)

SubjectRefDto

PropertyTypeRequiredDescription
idstringyes
kindSubjectKindyes

UpdateCapabilityProviderBindingDto

PropertyTypeRequiredDescription
credentialBindingIdstringno
isDefaultbooleanno
providerConfigobjectno
providerKindone of "model_modality", "http_endpoint", "worker", "integration", "platform_service"no
targetCapabilitiesarray of stringnoCapabilities the binding's target needs of its own to serve the ref (e.g. credential:resolve@1 for a connector operation that reads its connection's credential). A delegated caller lends them separately and the target is lent exactly these. Empty ⇒ the target needs nothing.