PtcRunner.Kernel.CommandContract (PtcRunner v0.14.0)

Copy Markdown View Source

Generated-in-source JSON Schema for the V3 command envelope.

The checked-in JSON artifact is produced from this module. Diagnostic phase/code/retryability/message rows come only from DiagnosticCatalog.

Envelope validation compiles that schema once per VM and reuses the JSV root. schema/0 still materializes the source map for generators and docs.

Summary

Functions

Builds the docs result: the served listing, or one embedded page.

Validates deterministic success-result ordering not fully expressible in JSON Schema.

Functions

docs_result(page)

@spec docs_result(binary() | nil) :: map()

Builds the docs result: the served listing, or one embedded page.

help_result(topic, frontend \\ :standalone)

schema()

@spec schema() :: map()

valid_success_semantics?(command, arg2)

@spec valid_success_semantics?(atom(), term()) :: boolean()

Validates deterministic success-result ordering not fully expressible in JSON Schema.

Callers that consume the generated schema must apply this predicate after ordinary schema validation for doctor and models results.

version_result()

@spec version_result() :: map()