schema-components - v3.7.0
    Preparing search index...

    Class SchemaNormalisationError

    The adapter failed to convert the input schema to JSON Schema.

    Causes: invalid Zod schema, Zod 3 schema (unsupported), malformed JSON Schema, missing OpenAPI ref, unsupported ref format, unrepresentable Zod types, conversion bugs, cycles, and duplicate ids. The kind field carries the precise classification — see the union declaration below.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    schema kind zodType

    Constructors

    • Parameters

      • message: string
      • schema: unknown
      • kind:
            | "unknown"
            | "invalid-zod"
            | "unsupported-schema"
            | "zod3-unsupported"
            | "zod-transform-unsupported"
            | "zod-type-unrepresentable"
            | "zod-conversion-failed"
            | "zod-conversion-bug"
            | "zod-cycle-detected"
            | "zod-duplicate-id"
            | "invalid-json-schema"
            | "openapi-missing-ref"
            | "openapi-invalid"
      • OptionalzodType: string
      • Optionalcause: unknown

      Returns SchemaNormalisationError

    Properties

    schema: unknown

    The schema input that caused the error.

    kind:
        | "unknown"
        | "invalid-zod"
        | "unsupported-schema"
        | "zod3-unsupported"
        | "zod-transform-unsupported"
        | "zod-type-unrepresentable"
        | "zod-conversion-failed"
        | "zod-conversion-bug"
        | "zod-cycle-detected"
        | "zod-duplicate-id"
        | "invalid-json-schema"
        | "openapi-missing-ref"
        | "openapi-invalid"
    zodType: string | undefined

    For zod-type-unrepresentable, the offending Zod type name (e.g. "bigint", "date", "map", "set"). undefined for other kinds.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties