@salesforce/b2c-tooling-sdk / docs / SearchIndex
Interface: SearchIndex
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:130
The search index structure stored in index.json.
Properties
entries
entries:
DocEntry[]
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:144
Array of documentation entries
generatedAt
generatedAt:
string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:134
Timestamp when the index was generated
platformDocVersion?
optionalplatformDocVersion:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:142
Platform documentation version the corpus was generated from (e.g. "DWAPP 26.8"), for corpora sourced from the DWAPP archive rather than a git repo (Script API). Absent on git-sourced corpora, which use source.
source?
optionalsource:SourceProvenance
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:136
Provenance of the upstream source content, when generated from a git repo.
version
version:
string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:132
Version of the index format