Interface: PatchSortFeatureDescriptionAmendment
@kortexya/reasoninglayer / PatchSortFeatureDescriptionAmendment
Interface: PatchSortFeatureDescriptionAmendment
Section titled “Interface: PatchSortFeatureDescriptionAmendment”Defined in: src/types/sorts.ts:1732
Amend the description of one feature declaration, and optionally its index directive.
Remarks
Section titled “Remarks”Merge-patch semantics, per key: an ABSENT key keeps the stored value,
null clears it, a value replaces it. A blank description is refused with
400 — null is how to clear. See PatchSortFeatureAmendment.
Properties
Section titled “Properties”cascadeTerms?
Section titled “cascadeTerms?”
optionalcascadeTerms?:undefined
Defined in: src/types/sorts.ts:1736
Not allowed on an amendment, which moves no term value (400).
description
Section titled “description”description:
string|null
Defined in: src/types/sorts.ts:1738
The declaration’s description: null clears it, a non-blank string replaces it.
index?
Section titled “index?”
optionalindex?:IndexDirectiveDto|null
Defined in: src/types/sorts.ts:1743
The declaration’s index directive. Absent keeps it, null returns it to
silence (which is NOT not_indexed), a value replaces it.
optionalname?:undefined
Defined in: src/types/sorts.ts:1734
Not allowed on an amendment: a rename is a separate call.