FsLiveDocs

HistoryModule

PackageFsLiveDocs.Core
Loads and verifies immutable inputs for a multi-version documentation build.

Summary

NameSignatureSynopsis
Operations
ApiModelSchemaVersionApiModelSchemaVersion No description available.
SemanticSchemaVersionSemanticSchemaVersion No description available.
ManifestSchemaVersionManifestSchemaVersion No description available.
sha256sha256 pathComputes the lowercase SHA-256 digest of a file.
loadArtifactloadArtifact expectedVersion expectedSha256 pathLoads an API artifact after checking its checksum, schema, and declared version.
loadSemanticArtifactloadSemanticArtifact expectedSha256 pathLoads renderer-neutral semantic documentation after checksum and schema validation.
loadManifestloadManifest pathLoads a history manifest and resolves entry paths relative to the manifest.

Operations

kind:member

ApiModelSchemaVersion

ApiModelSchemaVersion
Member

Returns

int
kind:member

SemanticSchemaVersion

SemanticSchemaVersion
Member

Returns

int
kind:member

ManifestSchemaVersion

ManifestSchemaVersion
Member

Returns

int
kind:member

sha256

sha256 path
Member
Computes the lowercase SHA-256 digest of a file.

Parameters

NameTypeDescription
pathstring

Returns

string
kind:member

loadArtifact

loadArtifact expectedVersion expectedSha256 path
Member
Loads an API artifact after checking its checksum, schema, and declared version.

Parameters

NameTypeDescription
expectedVersionstring
expectedSha256string
pathstring

Returns

PackageModel
kind:member

loadSemanticArtifact

loadSemanticArtifact expectedSha256 path
Member
Loads renderer-neutral semantic documentation after checksum and schema validation.

Parameters

NameTypeDescription
expectedSha256string
pathstring

Returns

SemanticDocumentationArtifact
kind:member

loadManifest

loadManifest path
Member
Loads a history manifest and resolves entry paths relative to the manifest.

Parameters

NameTypeDescription
pathstring

Returns

HistoryManifest * (HistoryEntry * string * string) list