@nestjs/swagger/dist/explorers/api-parameters.explorer.d.ts

Nest - modern, fast, powerful node.js web framework (@swagger)

import { Type } from '@nestjs/common';
import { SchemaObject } from '../interfaces/open-api-spec.interface.js';
import { ParamWithTypeMetadata } from '../services/parameter-metadata-accessor.js';
import { SchemaObjectFactory } from '../services/schema-object-factory.js';
export declare const exploreApiParametersMetadata: (schemas: Record<string, SchemaObject>, schemaObjectFactory: SchemaObjectFactory, instance: object, prototype: Type<unknown>, method: Function) => {
    parameters: (Partial<import("../interfaces/open-api-spec.interface.js").BaseParameterObject> | Partial<ParamWithTypeMetadata> | {
        schema: {
            type: string;
            items: any;
            nullable?: boolean;
            discriminator?: import("../interfaces/open-api-spec.interface.js").DiscriminatorObject;
            readOnly?: boolean;
            writeOnly?: boolean;
            xml?: import("../interfaces/open-api-spec.interface.js").XmlObject;
            externalDocs?: import("../interfaces/open-api-spec.interface.js").ExternalDocumentationObject;
            example?: any;
            examples?: any[] | Record<string, any>;
            deprecated?: boolean;
            allOf?: (SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject)[];
            oneOf?: (SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject)[];
            anyOf?: (SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject)[];
            not?: SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject;
            properties?: Record<string, SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject>;
            additionalProperties?: SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject | boolean;
            patternProperties?: SchemaObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject | any;
            description?: string;
            format?: import("../interfaces/open-api-spec.interface.js").OpenAPIFormat;
            default?: any;
            title?: string;
            multipleOf?: number;
            maximum?: number;
            exclusiveMaximum?: boolean;
            minimum?: number;
            exclusiveMinimum?: boolean;
            maxLength?: number;
            minLength?: number;
            pattern?: string;
            maxItems?: number;
            minItems?: number;
            uniqueItems?: boolean;
            maxProperties?: number;
            minProperties?: number;
            required?: string[];
            enum?: any[];
            'x-enumNames'?: string[];
        };
    } | {
        schema: Record<string, any>;
        description?: string;
        required?: boolean;
        deprecated?: boolean;
        allowEmptyValue?: boolean;
        style?: import("../interfaces/open-api-spec.interface.js").ParameterStyle;
        explode?: boolean;
        allowReserved?: boolean;
        examples?: Record<string, import("../interfaces/open-api-spec.interface.js").ExampleObject | import("../interfaces/open-api-spec.interface.js").ReferenceObject>;
        example?: any;
        content?: import("../interfaces/open-api-spec.interface.js").ContentObject;
    } | {
        schema: Record<string, any>;
        name?: string | number | object;
        type?: Type<unknown>;
        in?: import("../interfaces/open-api-spec.interface.js").ParameterLocation | "body" | "placeholder";
        standardSchema?: import("../index.js").StandardSchemaObject;
        isArray?: boolean;
        items?: SchemaObject;
        required?: boolean;
        enum?: unknown[];
        enumName?: string;
        enumSchema?: import("../interfaces/enum-schema-attributes.interface.js").EnumSchemaAttributes;
        selfRequired?: boolean;
    })[];
};