JsonSchema16

Models

DefinitionsinterfaceA record of named JSON Schema definitions, keyed by definition name.DialecttypeThe set of JSON Schema dialects supported by this module.DocumentinterfaceA structured container for a single JSON Schema and its associated definitions.JsonSchemainterfaceA plain object representing a single JSON Schema node.MultiDocumentinterfaceLike Document, but carries multiple root schemas that share a single definitions pool.TypetypeThe JSON Schema primitive type names.

Getters

resolve$reffunctionResolves a $ref string by looking up the last path segment in a definitions map.

Constants

META_SCHEMA_URI_DRAFT_07constRepresents the $schema meta-schema URI for JSON Schema Draft-07.META_SCHEMA_URI_DRAFT_2020_12constRepresents the $schema meta-schema URI for JSON Schema Draft 2020-12.

Decoding

fromSchemaDraft07functionParses a raw Draft-07 JSON Schema into a Document<"draft-2020-12">.fromSchemaDraft2020_12functionParses a raw Draft-2020-12 JSON Schema into a Document<"draft-2020-12">.fromSchemaOpenApi3_0functionParses a raw OpenAPI 3.0 JSON Schema into a Document<"draft-2020-12">.fromSchemaOpenApi3_1functionParses a raw OpenAPI 3.1 JSON Schema into a Document<"draft-2020-12">.

Encoding

toDocumentDraft07functionConverts a Document<"draft-2020-12"> to a Document<"draft-07">.toMultiDocumentOpenApi3_1functionConverts a MultiDocument<"draft-2020-12"> to a MultiDocument<"openapi-3.1">.

Transforming

resolveTopLevel$reffunctionResolves a document whose root schema is a top-level $ref.