@novice1/api-doc-generator - v1.2.0
    Preparing search index...

    Interface CommonPropsSchemaObject<T>

    interface CommonPropsSchemaObject<T> {
        $ref?: string;
        additionalProperties?: AdditionalProperties<T>;
        allOf?: (T | ReferenceObject)[];
        allowEmptyValue?: boolean;
        anyOf?: (T | ReferenceObject)[];
        default?: unknown;
        deprecated?: boolean;
        description?: string;
        discriminator?: DiscriminatorObject;
        enum?: unknown[];
        exclusiveMaximum?: boolean;
        exclusiveMinimum?: boolean;
        externalDocs?: ExternalDocObject;
        format?: string;
        items?: T | ReferenceObject;
        maximum?: number;
        maxItems?: number;
        maxLength?: number;
        maxProperties?: number;
        minimum?: number;
        minItems?: number;
        minLength?: number;
        minProperties?: number;
        multipleOf?: number;
        not?: T | ReferenceObject;
        oneOf?: (T | ReferenceObject)[];
        pattern?: string | RegExp;
        properties?: Record<string, T | ReferenceObject>;
        readOnly?: boolean;
        required?: string[];
        title?: string;
        uniqueItems?: boolean;
        writeOnly?: boolean;
        xml?: unknown;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Properties

    $ref?: string
    additionalProperties?: AdditionalProperties<T>
    allOf?: (T | ReferenceObject)[]
    allowEmptyValue?: boolean
    anyOf?: (T | ReferenceObject)[]
    default?: unknown
    deprecated?: boolean
    description?: string

    CommonMark syntax MAY be used for rich text representation.

    discriminator?: DiscriminatorObject
    enum?: unknown[]
    exclusiveMaximum?: boolean
    exclusiveMinimum?: boolean
    externalDocs?: ExternalDocObject
    format?: string
    items?: T | ReferenceObject
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    oneOf?: (T | ReferenceObject)[]
    pattern?: string | RegExp
    properties?: Record<string, T | ReferenceObject>
    readOnly?: boolean
    required?: string[]
    title?: string
    uniqueItems?: boolean
    writeOnly?: boolean
    xml?: unknown