DCC (version 1.2.1)

dcc_schema: Published JSON Schema for a DCC object

Description

Returns the formal JSON Schema (draft-07) for one of DCC's public objects. The schemas are versioned artifacts installed with the package under inst/schemas/, so AI systems and external validators can check a strict plan, normalized report model, rule file, action map, findings table, disposition, provenance, audit log, or manifest against a stable contract.

Usage

dcc_schema(name, as = c("object", "path"))

Value

The parsed schema (a list) or the schema file path.

Arguments

name

One of "finding", "disposition", "provenance", "audit_log", "rules", "actions", "manifest", "plan", or "report-model", plus the machine-report schemas "run", "validation", "summary", "audit_record", "reconciliation", "machine_provenance", and "artifact_manifest".

as

"object" (default) returns the parsed schema (requires the jsonlite package); "path" returns the installed file path.

See Also

dcc_capabilities for the capability document.

Examples

dcc_schema("finding", as = "path")
if (requireNamespace("jsonlite", quietly = TRUE)) {
  dcc_schema("actions")$title
}