Issue ​Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Interface · import type { Issue } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 17. Assets: describe, manifest, validation
One failed check at a path: what validate and checkAsset return, and what a HoloInputError carries.
| Member | Kind | Summary |
|---|---|---|
code |
property | What failed, e.g. 'unknown-field'; see IssueCode. |
path |
property | The JSON path or argument it is about. |
expected |
property | What was needed, in words or a type. |
received |
property | What was found. |
message |
property | At most 200 characters. |
didYouMean? |
property | Up to 3 close matches. |
docs |
property | URL of this code's page for this contract version. |
export interface Issue {
readonly code: IssueCode;
readonly path: string;
readonly expected: string;
readonly received: string;
readonly message: string;
readonly didYouMean?: readonly string[];
readonly docs: string;
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: Issue names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |