Documentation
    Preparing search index...

    Interface IV3_1<Type>

    JSON Schema unit for OpenAPI v3.1 specification.

    Uses OpenAPI v3.1 compatible JSON Schema format. v3.1 aligns more closely with JSON Schema draft 2020-12, supporting features like type arrays for nullable types and const values.

    interface IV3_1<Type> {
        __type?: Type;
        components: OpenApi.IComponents;
        schema: OpenApi.IJsonSchema;
        version: "3.1";
    }

    Type Parameters

    • Type

      Original TypeScript type for phantom type preservation

    Index

    Properties

    __type? components schema version

    Properties

    Optional__type

    __type?: Type

    Phantom property for TypeScript generic type preservation.

    This property exists only in the type system to preserve the Type generic parameter. It is always undefined at runtime and should not be accessed or used in application code.

    components: OpenApi.IComponents

    Reusable schema definitions for $ref references.

    Contains named schemas that can be referenced throughout the main schema. Essential for recursive types and reducing duplication.

    schema: OpenApi.IJsonSchema

    The main JSON schema definition for the type.

    Contains the complete schema for the target TypeScript type. May include $ref references to schemas in components.

    version: "3.1"

    OpenAPI specification version.

    Always "3.1" for this variant. Use this discriminator to determine which schema format is in use.

    Settings

    Member Visibility

    On This Page

    Properties