Interface IParameter

Path parameter definition for an API route.

interface IParameter {
    description: string;
    name: string & CamelCasePattern;
    schema:
        | AutoBeOpenApi.IJsonSchema.IInteger
        | AutoBeOpenApi.IJsonSchema.INumber
        | AutoBeOpenApi.IJsonSchema.IString;
}

Properties

description: string

Description of the path parameter.

MUST be written in English. Never use other languages.

Identifier name in camelCase. Must match the {paramName} in the AutoBeOpenApi.IOperation.path.

Type schema of the path parameter (primitive types only).