Guide to canonical schemas
guide_canonical_schemaReturns the exact machine schema for one canonical species: statement (default), the shape create_standard_statements accepts; chart, the shape create_standard_chart seals; or authorable declaration, the shape the declaration tools' document arm seals. For statement it is canonical JSON: one bare statement (schema, with each type's required controls, and an example), or several in the optional envelope (envelope_schema); topic csv adds how to build one from a CSV or bank export. Laws JSON Schema cannot express are listed in authoring_notes. Read-only, no workspace, and not metered.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Statement only: csv adds how to build a canonical statement from a CSV or bank export, with two worked examples. | |
| species | No | statement (default) | chart | declaration | |
| body_version | No | Chart only: 4, the current body (default), or 3, the body of charts sealed before node namespaces. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| engine | Yes | ||
| schema | Yes | ||
| status | Yes | ||
| example | No | ||
| species | Yes | ||
| csv_guide | No | ||
| csv_examples | No | ||
| schema_version | Yes | ||
| authoring_notes | Yes | ||
| envelope_schema | No |