# Interface JsonSchemaOptions

Interface

Module	import { JsonSchemaOptions } from "@tsed/schema"
Source	/packages/specs/schema/src/types/interfaces/JsonSchemaOptions.ts

# Overview

interface JsonSchemaOptions {
useAlias?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

components?<span class="token punctuation">:</span> Record&lt;<span class="token keyword">string</span><span class="token punctuation">,</span> <span class="token keyword">any</span>&gt;<span class="token punctuation">;</span>

specType?<span class="token punctuation">:</span> <a href="/api/specs/schema/types/domain/SpecTypes.html"><span class="token">SpecTypes</span></a><span class="token punctuation">;</span>

groups?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">[</span><span class="token punctuation">]</span> | false<span class="token punctuation">;</span>

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

customKeys?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
inlineEnums?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
<span class="token punctuation">[</span>key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">]</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
}

# Members

useAlias?: boolean;

Map properties with the alias name. By default, false

components?: Record<string, any>;

Reference to components Object.

specType?: SpecTypes;

Define Spec types level

groups?: string[] | false;

Define a groups restriction to generate the JsonSchema. Set false to disable groups.

groupsName?: string;

Set the postfix groups name for generated model and ref.

customKeys?: boolean;

Generate custom keys when SpecType is JSON.

inlineEnums?: boolean;

[key: string]: any;