SpecSerializerOptions

@tsed/schema

Usage

import { SpecSerializerOptions } from "@tsed/schema";

See /packages/specs/schema/src/utils/getSpec.ts.

Overview

interface SpecSerializerOptions extends JsonSchemaOptions {
    paths?: Record<string, any>;
    channels?: Record<string, any>;
    rootPath?: string;
    operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;
    operationIdPattern?: string;
}

paths

paths?: Record<string, any>;

Paths

channels

channels?: Record<string, any>;

Channels

rootPath

rootPath?: string;

Root path. This paths will be added to all generated paths Object.

operationIdFormatter:

operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;

A function to generate the operationId.

operationIdPattern

operationIdPattern?: string;

A pattern to generate the operationId.