Skip to content

JsonSchemaObject

@tsed/cli-mcp

Usage

typescript
import { JsonSchemaObject } from "@tsed/cli-mcp/src/utils/json-schema-to-zod/Types";

See /packages/cli-mcp/src/utils/json-schema-to-zod/Types.ts.

Overview

ts
type JsonSchemaObject = {
    type?: string | string[];
    properties?: {
        [key: string]: JsonSchema;
    };
    additionalProperties?: JsonSchema;
    unevaluatedProperties?: JsonSchema;
    patternProperties?: {
        [key: string]: JsonSchema;
    };
    minProperties?: number;
    maxProperties?: number;
    required?: string[] | boolean;
    propertyNames?: JsonSchema;
    items?: JsonSchema | JsonSchema[];
    additionalItems?: JsonSchema;
    minItems?: number;
    maxItems?: number;
    uniqueItems?: boolean;
    minLength?: number;
    maxLength?: number;
    pattern?: string;
    format?: string;
    minimum?: number;
    maximum?: number;
    exclusiveMinimum?: number | boolean;
    exclusiveMaximum?: number | boolean;
    multipleOf?: number;
    anyOf?: JsonSchema[];
    allOf?: JsonSchema[];
    oneOf?: JsonSchema[];
    if?: JsonSchema;
    then?: JsonSchema;
    else?: JsonSchema;
    const?: Serializable;
    enum?: Serializable[];
    errorMessage?: {
        [key: string]: string | undefined;
    };
} & {
    [key: string]: any;
};

type

ts
type?: string | string[];

properties

ts
properties?: {
     [key: string]: JsonSchema;
 };

additionalProperties

ts
additionalProperties?: JsonSchema;

unevaluatedProperties

ts
unevaluatedProperties?: JsonSchema;

patternProperties

ts
patternProperties?: {
     [key: string]: JsonSchema;
 };

minProperties

ts
minProperties?: number;

maxProperties

ts
maxProperties?: number;

required

ts
required?: string[] | boolean;

propertyNames

ts
propertyNames?: JsonSchema;

items

ts
items?: JsonSchema | JsonSchema[];

additionalItems

ts
additionalItems?: JsonSchema;

minItems

ts
minItems?: number;

maxItems

ts
maxItems?: number;

uniqueItems

ts
uniqueItems?: boolean;

minLength

ts
minLength?: number;

maxLength

ts
maxLength?: number;

pattern

ts
pattern?: string;

format

ts
format?: string;

minimum

ts
minimum?: number;

maximum

ts
maximum?: number;

exclusiveMinimum

ts
exclusiveMinimum?: number | boolean;

exclusiveMaximum

ts
exclusiveMaximum?: number | boolean;

multipleOf

ts
multipleOf?: number;

anyOf

ts
anyOf?: JsonSchema[];

allOf

ts
allOf?: JsonSchema[];

oneOf

ts
oneOf?: JsonSchema[];

if

ts
if?: JsonSchema;

then

ts
then?: JsonSchema;

else

ts
else?: JsonSchema;

const

ts
const?: Serializable;

enum

ts
enum?: Serializable[];

errorMessage

ts
errorMessage?: {
     [key: string]: string | undefined;
 };

ts
} & {

[key: string]

ts
[key: string]: any;

Released under the MIT License.