@trapi/metadata
Version:
Generate REST-API metadata scheme from TypeScript Decorators.
25 lines • 758 B
TypeScript
import type { Validator } from '../../utils';
import type { ArrayType, Type } from '../../resolver';
import type { Example } from '../type';
import type { CollectionFormat, ParameterSource } from './constants';
export interface Parameter {
parameterName: string;
description: string;
in: `${ParameterSource}`;
name: string;
required: boolean;
type: Type;
collectionFormat?: `${CollectionFormat}`;
allowEmptyValue?: boolean;
default?: any;
maxItems?: number;
minItems?: number;
deprecated?: boolean;
examples?: Example[];
exampleLabels?: string[];
validators?: Record<string, Validator>;
}
export interface ArrayParameter extends Parameter {
type: ArrayType;
}
//# sourceMappingURL=type.d.ts.map