Interface ParameterSchema

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12.

For more information about the properties, see JSON Schema Core and JSON Schema Validation.

Unless stated otherwise, the property definitions follow those of JSON Schema and do not add any additional semantics. Where JSON Schema indicates that behavior is defined by the application (e.g. for annotations), OAS also defers the definition of semantics to the application consuming the OpenAPI document.

See

https://spec.openapis.org/oas/latest.html#schema-object

interface ParameterSchema {
    $comment?: string;
    $defs?: {
        [key: string]: JSONSchema7Definition;
    };
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: JSONSchema7Definition;
    additionalProperties?: JSONSchema7Definition;
    allOf?: JSONSchema7Definition[];
    anyOf?: JSONSchema7Definition[];
    const?: JSONSchema7Type;
    contains?: JSONSchema7Definition;
    contentEncoding?: string;
    contentMediaType?: string;
    default?: JSONSchema7Type;
    definitions?: {
        [key: string]: JSONSchema7Definition;
    };
    dependencies?: {
        [key: string]: JSONSchema7Definition | string[];
    };
    description?: string;
    discriminator?: DiscriminatorObject;
    else?: JSONSchema7Definition;
    enum?: JSONSchema7Type[];
    example?: any;
    examples?: JSONSchema7Type;
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    externalDocs?: ExternalDocumentationObject;
    format?: string;
    if?: JSONSchema7Definition;
    items?: JSONSchema7Definition | JSONSchema7Definition[];
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    not?: JSONSchema7Definition;
    oneOf?: JSONSchema7Definition[];
    pattern?: string;
    patternProperties?: {
        [key: string]: JSONSchema7Definition;
    };
    properties: Record<string, SchemaObject>;
    propertyNames?: JSONSchema7Definition;
    readOnly?: boolean;
    required?: string[];
    then?: JSONSchema7Definition;
    title?: string;
    type?: JSONSchema7TypeName | JSONSchema7TypeName[];
    uniqueItems?: boolean;
    writeOnly?: boolean;
    xml?: XMLObject;
}

Hierarchy (view full)

Properties

$comment? $defs? $id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? const? contains? contentEncoding? contentMediaType? default? definitions? dependencies? description? discriminator? else? enum? example? examples? exclusiveMaximum? exclusiveMinimum? externalDocs? format? if? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? pattern? patternProperties? properties propertyNames? readOnly? required? then? title? type? uniqueItems? writeOnly? xml?

Properties

Optional $comment

$comment?: string

Optional $defs

$defs?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

See

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: JSONSchema7Definition

Optional additionalProperties

additionalProperties?: JSONSchema7Definition

Optional allOf

allOf?: JSONSchema7Definition[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7

Optional anyOf

anyOf?: JSONSchema7Definition[]

Optional const

const?: JSONSchema7Type

Optional contains

contains?: JSONSchema7Definition

Optional contentEncoding

contentEncoding?: string

Optional contentMediaType

contentMediaType?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8

Optional default

default?: JSONSchema7Type

Optional definitions

definitions?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9

Optional dependencies

dependencies?: {
    [key: string]: JSONSchema7Definition | string[];
}

Type declaration

Optional description

description?: string

CommonMark syntax MAY be used for rich text representation.

Optional discriminator

discriminator?: DiscriminatorObject

Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See Composition and Inheritance for more details.

Optional else

else?: JSONSchema7Definition

Optional enum

enum?: JSONSchema7Type[]

Optional example

example?: any

A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

Deprecated

The example property has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.

Optional examples

examples?: JSONSchema7Type

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional externalDocs

externalDocs?: ExternalDocumentationObject

Additional external documentation for this schema.

Optional format

format?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7

Optional if

if?: JSONSchema7Definition

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6

Optional items

items?: JSONSchema7Definition | JSONSchema7Definition[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4

Optional maxItems

maxItems?: number

Optional maxLength

maxLength?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3

Optional maxProperties

maxProperties?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5

Optional maximum

maximum?: number

Optional minItems

minItems?: number

Optional minLength

minLength?: number

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2

Optional not

not?: JSONSchema7Definition

Optional oneOf

oneOf?: JSONSchema7Definition[]

Optional pattern

pattern?: string

Optional patternProperties

patternProperties?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

properties

properties: Record<string, SchemaObject>

Optional propertyNames

propertyNames?: JSONSchema7Definition

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional then

then?: JSONSchema7Definition

Optional title

title?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10

Optional type

type?: JSONSchema7TypeName | JSONSchema7TypeName[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1

Optional uniqueItems

uniqueItems?: boolean

Optional writeOnly

writeOnly?: boolean

Optional xml

xml?: XMLObject

This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.

Settings

Member Visibility

Theme

On This Page

$comment$defs$id$ref$schemaadditionalItemsadditionalPropertiesallOfanyOfconstcontainscontentEncodingcontentMediaTypedefaultdefinitionsdependenciesdescriptiondiscriminatorelseenumexampleexamplesexclusiveMaximumexclusiveMinimumexternalDocsformatifitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnotoneOfpatternpatternPropertiespropertiespropertyNamesreadOnlyrequiredthentitletypeuniqueItemswriteOnlyxml