asdf_pydantic.schema

asdf_pydantic.schema#

Attributes#

DEFAULT_ASDF_SCHEMA_REF_TEMPLATE

DESIRED_ASDF_SCHEMA_KEY_ORDER

Classes#

GenerateAsdfSchema

Generates ASDF-compatible schema from Pydantic's default JSON schema generator.

Module Contents#

asdf_pydantic.schema.DEFAULT_ASDF_SCHEMA_REF_TEMPLATE = '#/definitions/{model}'#
asdf_pydantic.schema.DESIRED_ASDF_SCHEMA_KEY_ORDER = ('$schema', 'id', 'title', 'type', 'properties', 'allOf', 'anyOf', 'required', 'definitions')#
class asdf_pydantic.schema.GenerateAsdfSchema(by_alias: bool = True, ref_template: str = DEFAULT_ASDF_SCHEMA_REF_TEMPLATE, tag_uri: str | None = None)#

Bases: pydantic.json_schema.GenerateJsonSchema

Generates ASDF-compatible schema from Pydantic’s default JSON schema generator.

`{caution} Experimental This schema generator is not complete. It currently creates JSON 2020-12 schema (despite `$schema` says it's `asdf-schema-1.0.0`) which are not compatible with ASDF. `

schema_dialect = 'http://stsci.edu/schemas/asdf/asdf-schema-1.0.0'#
tag_uri#
generate(schema, mode='validation')#
Contents