# Interface 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?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>

rootPath?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

operationIdFormatter?<span class="token punctuation">:</span> <span class="token punctuation">(</span>name<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> propertyKey<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> path<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span> =&gt; <span class="token keyword">string</span><span class="token punctuation">;</span>

operationIdPattern?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

}

# 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