Metaschema Syntax

The following is an approximate outline of the Metaschema module syntax. Each element and attribute links to the specific specification section describing the element. Attribute value choices are indicated where possible, with default values highlighted.
<-- ############# -->
<-- Module Header -->
<-- ############# --><METASCHEMA xmlns="http://csrc.nist.gov/ns/oscal/metaschema/1.0"
abstract="yes|no"> (default: no)
<schema-name>string</schema-name>
<schema-version>string</schema-version>
<short-name>string</short-name>
<namespace>uri</namespace>
<json-base-uri>uri</json-base-uri>
<remarks>markup-multiline</remarks>
<-- ############## -->
<-- Module Imports -->
<-- ############## --><import href="uri-reference"/>
<-- ##################### -->
<-- Top-Level define-flag -->
<-- ##################### --><define-flag name="token"
as-type="token" (default: string)
default="string"
deprecated="string"
scope="global|local"> (default: global)
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<constraint/>
<remarks>markup-multiline</remarks>
<example/>
</define-flag>
<-- ######################### -->
<-- Top-Level define-assembly -->
<-- ######################### --><define-assembly name="token"
deprecated="string"
scope="global|local"> (default: global)
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<root-name>token</root-name>
<json-key flag-ref="token"/>
<-- Flag Instance -->
<flag ref="token"
required="yes|no" (default: no)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<remarks>markup-multiline</remarks>
</flag>
<-- Inline Flag Definition -->
<define-flag name="token"
as-type="token" (default: string)
default="string"
required="yes|no" (default: no)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<constraint/>
<remarks>markup-multiline</remarks>
<example/>
</define-flag>
<model>
<-- Assembly Instance -->
<assembly ref="token"
min-occurs="non-negative-integer" (default: 0)
max-occurs="positive-integer|unbounded" (default: 1)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<group-as name="token"
in-json="ARRAY|SINGLETON_OR_ARRAY|BY_KEY" (default: SINGLETON_OR_ARRAY)
in-xml="GROUPED|UNGROUPED"/> (default: UNGROUPED)
<remarks>markup-multiline</remarks>
</assembly>
<-- Field Instance -->
<field ref="token"
min-occurs="non-negative-integer" (default: 0)
max-occurs="positive-integer|unbounded" (default: 1)
in-xml="WRAPPED|UNWRAPPED" (default: WRAPPED)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<group-as name="token"
in-json="ARRAY|SINGLETON_OR_ARRAY|BY_KEY" (default: SINGLETON_OR_ARRAY)
in-xml="GROUPED|UNGROUPED"/> (default: UNGROUPED)
<remarks>markup-multiline</remarks>
</field>
<-- Inline Assembly Definition -->
<define-assembly/>
<-- Inline Field Definition -->
<define-field/>
<-- Choice -->
<choice/>
<-- Any -->
<any/>
</model>
<constraint/>
<remarks>markup-multiline</remarks>
<example/>
</define-assembly>
<-- ###################### -->
<-- Top-Level define-field -->
<-- ###################### --><define-field name="token"
as-type="token" (default: string)
default="string"
collapsible="yes|no" (default: no)
deprecated="string"
scope="global|local"> (default: global)
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<json-key flag-ref="token"/>
<json-value-key>token</json-value-key>
<json-value-key-flag flag-ref="token"/>
<-- Flag Instance -->
<flag ref="token"
required="yes|no" (default: no)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<use-name>token</use-name>
<remarks>markup-multiline</remarks>
</flag>
<-- Inline Flag Definition -->
<define-flag name="token"
as-type="token" (default: string)
default="string"
required="yes|no" (default: no)
deprecated="string">
<formal-name>string</formal-name>
<description>string</description>
<prop name="token" value="token"
namespace="uri"/> (default: http://csrc.nist.gov/ns/oscal/metaschema/1.0)
<constraint/>
<remarks>markup-multiline</remarks>
<example/>
</define-flag>
<constraint/>
<remarks>markup-multiline</remarks>
<example/>
</define-field>
</METASCHEMA>