Reference

parse_schema_markdown

schema_markdown.parse_schema_markdown(text, types=None, filename='', validate=True)

Parse Schema Markdown from a string or an iterator of strings

Parameters:

• text (str or Iterable(str)) – The Schema Markdown text

• types (object) – The type model

• filename (str) – The name of file being parsed (for error messages)

• validate (bool) – If True, validate after parsing

Returns:

The type model

Raises:

SchemaMarkdownParserError – A parsing error occurred

validate_type

schema_markdown.validate_type(types, type_name, value, member_fqn=None)

Type-validate a value using the schema-markdown user type model. Container values are duplicated since some member types are transformed during validation.

Validates JSON-like values. In this implementation, date values are date, datetime values are datetime, and uuid strings remain strings. date, datetime, and UUID inputs are left unchanged. See the language documentation on built-in types for accepted JSON input formats and host-runtime behavior.

Parameters:

• types (dict) – The type model

• type_name (str) – The type name

• value (object) – The value object to validate

• member_fqn (str) – The fully-qualified member name

Returns:

The validated, transformed value object

Raises:

ValidationError – A validation error occurred