Interface Issue

One finding produced by inspectDataModel.

interface Issue {
    code: string;
    context?: Record<string, unknown>;
    message: string;
    resourceId?: string;
    severity: inspect.dataModel.IssueSeverity;
    summary?: string;
}

Properties

code context? message resourceId? severity summary?

Properties

code

code: string

Stable code (e.g. "OBJECT_UNKNOWN_TYPE"). Built-in codes are CONSTANT_CASE; custom inspections should namespace ("MyApp/CHECK_NAMING").

Optionalcontext

context?: Record<string, unknown>

Structured payload for tooling. Consumers should treat missing keys defensively.

message

message: string

OptionalresourceId

resourceId?: string

The DataModel resource this issue is about. DataObject ids pass through directly; Relationships — which have no stable id — get a synthetic ${relating}->${related}#${type} locator.

severity

severity: inspect.dataModel.IssueSeverity

Optionalsummary

summary?: string

Optional one-line summary for UI rendering — the few ids / type names worth surfacing without parsing message.

Settings

Member Visibility

On This Page

Properties