1 |
|
2 | import { Type } from '@nestjs/common';
|
3 | import { SchemaObject } from '../interfaces/open-api-spec.interface';
|
4 | import { ParamWithTypeMetadata } from '../services/parameter-metadata-accessor';
|
5 | export declare const exploreApiParametersMetadata: (schemas: Record<string, SchemaObject>, instance: object, prototype: Type<unknown>, method: Function) => {
|
6 | parameters: (Partial<import("../interfaces/open-api-spec.interface").BaseParameterObject> | Partial<ParamWithTypeMetadata> | {
|
7 | schema: {
|
8 | type: string;
|
9 | items: any;
|
10 | nullable?: boolean;
|
11 | discriminator?: import("../interfaces/open-api-spec.interface").DiscriminatorObject;
|
12 | readOnly?: boolean;
|
13 | writeOnly?: boolean;
|
14 | xml?: import("../interfaces/open-api-spec.interface").XmlObject;
|
15 | externalDocs?: import("../interfaces/open-api-spec.interface").ExternalDocumentationObject;
|
16 | example?: any;
|
17 | examples?: any[] | Record<string, any>;
|
18 | deprecated?: boolean;
|
19 | allOf?: (SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject)[];
|
20 | oneOf?: (SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject)[];
|
21 | anyOf?: (SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject)[];
|
22 | not?: SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject;
|
23 | properties?: Record<string, SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject>;
|
24 | additionalProperties?: boolean | SchemaObject | import("../interfaces/open-api-spec.interface").ReferenceObject;
|
25 | patternProperties?: any;
|
26 | description?: string;
|
27 | format?: string;
|
28 | default?: any;
|
29 | title?: string;
|
30 | multipleOf?: number;
|
31 | maximum?: number;
|
32 | exclusiveMaximum?: boolean;
|
33 | minimum?: number;
|
34 | exclusiveMinimum?: boolean;
|
35 | maxLength?: number;
|
36 | minLength?: number;
|
37 | pattern?: string;
|
38 | maxItems?: number;
|
39 | minItems?: number;
|
40 | uniqueItems?: boolean;
|
41 | maxProperties?: number;
|
42 | minProperties?: number;
|
43 | required?: string[];
|
44 | enum?: any[];
|
45 | };
|
46 | } | {
|
47 | schema: import("lodash").Dictionary<any>;
|
48 | description?: string;
|
49 | required?: boolean;
|
50 | deprecated?: boolean;
|
51 | allowEmptyValue?: boolean;
|
52 | style?: import("../interfaces/open-api-spec.interface").ParameterStyle;
|
53 | explode?: boolean;
|
54 | allowReserved?: boolean;
|
55 | examples?: Record<string, import("../interfaces/open-api-spec.interface").ReferenceObject | import("../interfaces/open-api-spec.interface").ExampleObject>;
|
56 | example?: any;
|
57 | content?: import("../interfaces/open-api-spec.interface").ContentObject;
|
58 | } | {
|
59 | schema: import("lodash").Dictionary<any>;
|
60 | name?: string | number | object;
|
61 | type?: Type<unknown>;
|
62 | in?: import("../interfaces/open-api-spec.interface").ParameterLocation | "body" | "placeholder";
|
63 | isArray?: boolean;
|
64 | required?: true;
|
65 | enum?: unknown[];
|
66 | enumName?: string;
|
67 | })[];
|
68 | };
|