ReleaseCapsuleModule
PackageFsLiveDocs.Core
Creates, validates, inspects, and extracts deterministic release capsules.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| ManifestSchemaVersion | ManifestSchemaVersion | No description available. |
| ContentSchemaVersion | ContentSchemaVersion | No description available. |
| HistoryIndexSchemaVersion | HistoryIndexSchemaVersion | No description available. |
| create | create path sourceRevision captureToolVersion api semantic site pages assets | Creates a complete capsule without overwriting an existing release. |
| load | load path | Verifies a capsule and returns its manifest and component models. |
| inspect | inspect path | Inspects and fully verifies a capsule without extracting it. |
| materializeContent | materializeContent path destination | Materializes renderer-neutral content under a validated destination. |
| loadHistoryIndex | loadHistoryIndex path | Loads a capsule history index and validates its structural invariants. |
| acquire | acquire indexRoot cacheRoot entry | Resolves a local or remote capsule into the checksum-addressed download cache. |
Operations
kind:member
Creates a complete capsule without overwriting an existing release.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | |
| sourceRevision | string | |
| captureToolVersion | string | |
| api | ApiModelArtifact | |
| semantic | SemanticDocumentationArtifact | |
| site | SiteConfig | |
| pages | ReleaseContentPage list | |
| assets | (string * byte array) list |
Returns
ReleaseCapsuleReport
kind:member
kind:member
kind:member
kind:member