Interface: VocabularyRevisionMutationOptions
@kortexya/reasoninglayer / VocabularyRevisionMutationOptions
Interface: VocabularyRevisionMutationOptions
Section titled “Interface: VocabularyRevisionMutationOptions”Defined in: src/types/vocabulary.ts:301
The per-call options of a mutation that edits a candidate’s head revision (save and rebase).
Remarks
Section titled “Remarks”ifMatch names the head revision the edit was made on: the revision id, or
the candidate’s ETag ("<revision_id>"; the quotes are optional). A stale
value is refused 412 (PreconditionFailedError, whose currentEtag
names the current head).
Extends
Section titled “Extends”Properties
Section titled “Properties”causal?
Section titled “causal?”
optionalcausal?:AuditCausalHeaders
Defined in: src/types/common.ts:97
Causal assertions for the audit ledger, sent as the x-osfkb-* request
headers. See AuditCausalHeaders.
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.causal
idempotencyKey
Section titled “idempotencyKey”idempotencyKey:
string
Defined in: src/types/vocabulary.ts:288
The Idempotency-Key header.
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.idempotencyKey
ifMatch
Section titled “ifMatch”ifMatch:
string
Defined in: src/types/vocabulary.ts:303
The If-Match header: the head revision id or its ETag.
namespaceId?
Section titled “namespaceId?”
optionalnamespaceId?:string
Defined in: src/types/common.ts:84
Override the namespace for this request (X-Namespace-Id header).
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.namespaceId
retries?
Section titled “retries?”
optionalretries?:number
Defined in: src/types/common.ts:92
Number of retry attempts for this request. Set to 0 to disable retries.
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.retries
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: src/types/common.ts:88
AbortSignal for request cancellation.
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.signal
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: src/types/common.ts:90
Per-call timeout in milliseconds. Overrides the client-level timeoutMs default.
Inherited from
Section titled “Inherited from”VocabularyMutationOptions.timeoutMs
userId?
Section titled “userId?”
optionaluserId?:string
Defined in: src/types/common.ts:86
Override the user ID for this request (X-User-Id header). Used for admin impersonation.