Interface Schema

Schema is used to define the format of input/output data.

Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

interface Schema {
    anyOf?: Schema[];
    default?: unknown;
    description?: string;
    enum?: string[];
    example?: unknown;
    format?: string;
    items?: Schema;
    maximum?: number;
    maxItems?: string;
    maxLength?: string;
    maxProperties?: string;
    minimum?: number;
    minItems?: string;
    minLength?: string;
    minProperties?: string;
    nullable?: boolean;
    pattern?: string;
    properties?: Record<string, Schema>;
    propertyOrdering?: string[];
    required?: string[];
    title?: string;
    type?: Type;
}

Properties

anyOf? default? description? enum? example? format? items? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? nullable? pattern? properties? propertyOrdering? required? title? type?

Properties

OptionalanyOf

anyOf?: Schema[]

Optional. The value should be validated against any (one or more) of the subschemas in the list.

Optionaldefault

default?: unknown

Optional. Default value of the data.

Optionaldescription

description?: string

Optional. The description of the data.

Optionalenum

enum?: string[]

Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}

Optionalexample

example?: unknown

Optional. Example of the object. Will only populated when the object is the root.

Optionalformat

format?: string

Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

Optionalitems

items?: Schema

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

Optionalmaximum

maximum?: number

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

OptionalmaxItems

maxItems?: string

Optional. Maximum number of the elements for Type.ARRAY.

OptionalmaxLength

maxLength?: string

Optional. Maximum length of the Type.STRING

OptionalmaxProperties

maxProperties?: string

Optional. Maximum number of the properties for Type.OBJECT.

Optionalminimum

minimum?: number

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

OptionalminItems

minItems?: string

Optional. Minimum number of the elements for Type.ARRAY.

OptionalminLength

minLength?: string

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

OptionalminProperties

minProperties?: string

Optional. Minimum number of the properties for Type.OBJECT.

Optionalnullable

nullable?: boolean

Optional. Indicates if the value may be null.

Optionalpattern

pattern?: string

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

Optionalproperties

properties?: Record<string, Schema>

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

OptionalpropertyOrdering

propertyOrdering?: string[]

Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.

Optionalrequired

required?: string[]

Optional. Required properties of Type.OBJECT.

Optionaltitle

title?: string

Optional. The title of the Schema.

Optionaltype

type?: Type

Optional. The type of the data.

Settings

On This Page

Properties