@ordercloud/oc-codegen/lib/src/models/param.model.d.ts

OpenAPI codegen tool built for the OrderCloud API

export interface Param {
    name: string;
    description: string;
    type: string;
    isArray: boolean;
    isPrimitive: boolean;
    isComplexType: boolean;
    isCustomType: boolean;
    isReadOnly: boolean;
    isEnum: boolean;
    isRequired: boolean;
    isQueryParam: boolean;
    isPathParam: boolean;
    isBodyParam: boolean;
    isXp: boolean;
    hasRequiredFields: boolean;
    requiredFields: string[];
    /**
     * a param can have `isEnum` true and no values
     * if it has a schema.$ref associated with it meaning that enum
     * is a model that can be referenced
     */
    enumValues: string[];
    format: string;
    maxLength: number;
    minLength: number;
    minimum: number;
    maximum: number;
    default: any;
}