Documentation
    Preparing search index...

    Interface IV3_1<Types>

    JSON Schema collection 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<Types = unknown[]> {
        __types?: Types;
        components: OpenApi.IComponents;
        schemas: OpenApi.IJsonSchema[];
        version: "3.1";
    }

    Type Parameters

    • Types = unknown[]

      Tuple of original TypeScript types for phantom type preservation

    Index

    Properties

    __types? components schemas version

    Properties

    Optional__types

    __types?: Types

    Phantom property for TypeScript generic type preservation.

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

    components: OpenApi.IComponents

    Shared schema definitions for $ref references.

    Contains named schemas used across multiple types in the collection. Reduces duplication when types share common structures.

    schemas: OpenApi.IJsonSchema[]

    Generated JSON schemas, one per input type.

    Array of schemas in the same order as the input type tuple. Each schema may reference definitions 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