schema.xml.metaschema.xsd Maven / Gradle / Ivy
This prose module provides support for line and multiline markup.
This datatypes module provides support for all other built-in Metaschema data types.
Root element of an OSCAL Metaschema definition. Defines a family of data
structures representing a model.
The name of the information model represented by this Metaschema definition.
The namespace for the collection of Metaschema models this Metaschema definition
belongs to. Also the XML namespace governing the names of elements in XML documents, which
expect to be conformant to the schemas expressed by this metaschema. By using this
namespace, documents and document fragments used in mixed-format environments may be
distinguished from neighbor XML formats using other namespaces. This value is not reflected in
OSCAL JSON.
To import a set of Metaschema definitions from an out-of-line resource, supporting reuse of common information structures.
A relative or absolute URI for retrieving an out-of-line Metaschema definition.
Root element of an OSCAL Metaschema external constraints definition. Defines rules to be applied to an existing set of Metaschema models.
The name of this constraint set.
The version of this constraint set.
To import a set of Metaschema constraints from an out-of-line resource, supporting composition of constraint sets.
A relative or absolute URI for retrieving an out-of-line Metaschema definition.
The type of all definition and instance names.
An element with structured element content in XML; in JSON, an object with
properties. Defined globally, an assembly can be assigned to appear in the model of any assembly (another assembly type, or itself), by assembly reference.
Used inside a field definition, designates a name (key) for the property in JSON containing the field's value. Use of a 'json-value-key' is mutually exclusive with a 'json-value-key-flag'.
Used inside a field definition, designates a flag whose value is to be used as the name (key) for the property in JSON containing the field's value. Use of a 'json-value-key-flag' is mutally exclusive with a 'json-value-key'.
In JSON, an object with a nominal string value (potentially with internal
inline - not fully structured - markup). In XML, an element with string or markup
content. Defined globally, a field can be assigned to appear in the model of any assembly by field reference.
A data point to be expressed as an attribute in the XML or a name/value pair
in the JSON. A flag may also be defined implicitly with the assembly or field to which it
applies. Defined globally, a flag can be assigned to any field or assembly by flag reference.
In JSON, an object with a nominal string value (potentially with internal
inline - not fully structured - markup). In XML, an element with string or markup
content. A local definition describes and constrains the appearance of the field only in this (assembly) context.
In JSON, an object with a nominal string value (potentially with internal
inline - not fully structured - markup). In XML, an element with string or markup
content. A local definition describes and constrains the appearance of the field only in this (assembly) context.
A field with assigned datatype 'markup-multiline' may be designated for representation with or without a containing (wrapper) element
in XML.
A data point to be expressed as an attribute in the XML or a name/value pair in the JSON. A local definition describes and constrains the appearance of the flag only in its parent (assembly or field) context.
A formal name for the data construct, to be presented in documentation. It
is permissible for a formal name to provide nothing but an expanson of what is already given
by a tag (for example, this element could have formal name "Formal name") but it should at
the very least confirm the intended semantics for the user, not confuse them.
The JSON Base URI is nominal base URI assigned to a JSON Schema instance expressing the model defined by this metaschema.
A short description of the data construct, to be inserted into
documentation. Unlike 'formal-name' this should not simply repeat what is readily
discernible from a tag (element name or JSON label), but say a little more about
it.
Any explanatory or helpful information to be provided in the
documentation of an assembly, field or flag.
Mark as 'XML' for XML-only or 'JSON' for JSON-only remarks.
The remark applies to only XML representations.
The remark applies to only JSON and YAML representations.
A version string used to distinguish between multiple revisions of the same resource.
A short (code) name to be used for the metaschema, for example as a constituent of names assigned to
derived artifacts such as schemas and conversion utilities.
Referencing an assembly definition to include an assembly or assemblies of a given type in a model.
Referencing a field definition to include a field or fields of a given type in a model.
A field with assigned datatype 'markup-multiline' may be designated for representation with or without a containing (wrapper) element
in XML.
Any paragraph or block contents of a markup-multiline field will be represented with a containing (wrapper) element in the XML.
With in-xml='UNWRAPPED', a field contents will be represented in the XML with no wrapper, so the field will be implicit. Among sibling fields in a given model, only one of them may be designated as UNWRAPPED.
Minimum occurrence of assemblies or fields within a valid model. The default value is 0, for an optional occurrence.
Maximum occurrence of assemblies or fields within a valid model. The default value is 1, for a single occurrence. 'unbounded' permits any number of assemblies of the designated type.
A violation of the constraint represents a serious fault in the content
that will prevent typical use of the content.
A violation of the constraint represents a fault in the content. This
may include issues around compatibility, integrity, consistency, etc.
A violation of the constraint represents a potential issue
with the content.
A violation of the constraint represents a point of
interest.
Indicates a set of values to be recognized for a flag or field, with semantics asserted by a metaschema enumeration (enum).
The given enumerated value or values are inclusive of other values ('yes') or not ('no', the default)
Determines if the given enumerated value or values within a namespace may be extended by other allowed value constraints.
Can be extended by constraints within the same model.
Can be extended by external constraints.
Cannot be extended.
An enumerated value for a flag or field. The value is indicated by the 'value' attribute while the element contents describe the intended semantics for documentation.
A value recognized for a flag or field.
The associated construct has been deprecated at the specified version. Its use should be avoided if possible.
A regex subset that is conformant to both https://www.w3.org/TR/xmlschema11-2/#regexes and https://www.ecma-international.org/ecma-262/11.0/index.html#sec-patterns.
Specifies the datatype for which the value identified by the scope
attribute must conform to.
Specifies the target of the constraint as a metaschema path. If the value is "." and the containing metaschema object is a field, the constraint applies to the field's value. Otherwise, the scope value "." is not allowed to be used.
Specifies the target of the constraint as a metaschema path. If the value is "." and the containing metaschema object is a field, the constraint applies to the field's value.
Constrains the allowed values for the flag.
Constrains the allowed values based on the provided regex pattern.
Checks that the specified key-field values match a key in the index with the specified name.
Checks that the specified test returns true in this evaluation context.
Specifies the field or flag value that is used to generate the key for a given object that is a member of this index. If more than one key-field is provided, then the key is a composition of the specified key-fields. The ordering of the key-field defined the relative order of the index's key. The field or flag values pointed to must be a field value or a required flag value.
Defines an unique key constraint.
Specifies a value, relative to the provided target,
that is to be used as part of the key. More than one key-field can be used to create
a composite key.
The first captured group in the regular expression is used
as the key value for lookup. The regular expression must not match a
zero-length string.
Specifies the value objects to be included in the key constraint, or the object that contains a reference to an item in an index. If the value is ".", then the key is targeting the current metaschema object.
Defines an index, a check against an index, or a uniqueness constraint.
Specifies the name of the index, a reference to an index, or the name of a uniqueness constraint.
Defines an index, a check against an index, or a uniqueness constraint.
Specifies the value objects to be included in the index constraint, or the object that contains a reference to an item in an index. If the value is ".", then the key is targeting the current metaschema object.
Defines an index, a check against an index, or a uniqueness constraint.
Specifies the value objects to be included in the index constraint, or the object that contains a reference to an item in an index. If the value is ".", then the key is targeting the current metaschema object.
Specifies the name of the index, a reference to an index, or the name of a uniqueness constraint.
A test that is expected to pass in this context. Presently, datatyping
is not directly supported except by explicit use of data type casting functions, e.g.
xs:double() and xs:date().
Specifies the target of the constraint as a metaschema path. If the value is "." and the containing metaschema object is a field or flag, the constraint applies to the value of the field or flag. Otherwise, the scope value "." is not allowed to be used.
Constrains the allowed values for the flag or field referenced by the scope attribute.
Constrains the allowed values based on the provided regex pattern or checks that the value is conformant to the specified datatype.
Checks that the specified key-field values match a key in the index with the specified name.
Checks that the specified test returns true in this evaluation context.
Specifies the target of the constraint as a metaschema path. If the
value is "." and the containing metaschema object is a field, the constraint applies
to the field's value. Otherwise, the scope value "." is not allowed to be
used.
Minimum occurrence of assemblies or fields within the set of objects
identified by the target. This value cannot be less than the
corresponding value defined on the target.
Maximum occurrence of assemblies or fields within the set of objects
identified by the target. This value must be less than the corresponding
value defined on the target.
Defines a new named index. Each entry in the index will have a unique key, based on the key-field elements, and an associated object value, based on the target selection..
Checks that the specified set of target entries have a key, based on the key-field entries that is unique. The name identifies the name of the uniqueness constraint, which can be used for error reporting, etc.
Checks that the specified set of target entries match the provided cardinality.
Within a model, indicates that only one of a set of fields or assemblies, referenced in the choice, may occur in valid instances.
Within a model, a foreign element may be permitted here..
In the XML, produces an attribute with the given name, whose value is used as a key value (aka object property name) in the JSON, enabling objects to be 'lifted' out of arrays when such values are distinct. Implies that siblings will never share values. Overloading with datatype 'ID' and naming the key 'id' is legitimate and useful. Even without ID validation, uniqueness of these values among siblings is validable.
When a given referenced field or assembly must be wrapped in an outer grouping, these settings apply, including a name for the group, and how to express the grouping in the respective formats. Not necessary when a field or assembly has max-occurs='1'
How to represent a grouping in JSON
Whether to represent a grouping explicitly in XML
Always use an array
Produce a singleton for a single member (field or assembly) or an array for multiple members
For any group (one or more members) produce an object with properties for each member, using a designated flag for their key (label) values, which must be distinct
Use a wrapper element
Do not use a wrapper element
A string with no leading or trailing whitespace.
This definition is only available in the context of the current metaschema.
This definition will be made available to any metaschema that includes this one either directly or indirectly through a chain of imported metaschemas.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy