CategoryDescriptor
What a category field value resolves to. A stored category value is a pointer and nothing else;
everything below key is written by delivery at request time, which is why renaming a category in
Settings renames it on every page at once with nothing republished.
Only provider and key are guaranteed:
path,valueandgroupExternalIdare written only when the category still exists. A category deleted since publish deliversresolved: falseand none of the three — rendering nothing is the honest response, and a dangling id is not.resolvedis itself optional, because enrichment only reaches a descriptor carrying thekindstamp, and content published before that stamp existed is left alone until its next republish. Soresolved === undefinedmeans “published before the stamp”, distinct fromfalse.
Properties
Section titled “Properties”groupExternalId?
Section titled “groupExternalId?”
optionalgroupExternalId?:string
key:
string
optionalkind?:"category"
The delivered discriminator. Absent on content frozen before it was introduced.
optionalpath?:string
group/parent/child — the stable identity to filter on, never the label.
provider
Section titled “provider”provider:
string
resolved?
Section titled “resolved?”
optionalresolved?:boolean
false once the category has been deleted; see the note above on undefined.
value?
Section titled “value?”
optionalvalue?:string|null
The locale-resolved display label. null where the category itself has no value for the resolved locale chain.