# SpecSerializerOptions Interface

Module
import { SpecSerializerOptions } from "@tsed/schema"
Source/packages/schema/src/utils/getSpec.ts

# Overview

interface SpecSerializerOptions extends JsonSchemaOptions {
    specType?: SpecTypes.SWAGGER | SpecTypes.OPENAPI;
    /**
     * Paths
     */
    paths?: any;
    /**
     * Root path. This paths will be added to all generated paths Object.
     */
    rootPath?: string;
    /**
     * A function to generate the operationId.
     */
    operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;
    /**
     * A pattern to generate the operationId.
     */
    operationIdPattern?: string;
}

# Members

specType?: SpecTypes.SWAGGER | SpecTypes.OPENAPI;

paths?: any;

Paths


rootPath?: string;

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


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

A function to generate the operationId.


operationIdPattern?: string;

A pattern to generate the operationId.

Other topics