Skip to main content

Interface: $Properties

Properties of a JSONSchema.

Extended by​

Properties​

array?​

optional array?: string[] | null

Items in 'array' must be unique.

default?​

optional default?: string | null

JSONSchema default

description?​

optional description?: string | null

A short description of the schema.

enum?​

optional enum?: string[] | null

Items in enum must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1

example?​

optional example?: string | null

A free-form property to include a JSON example of this field. This is copied verbatim to the output swagger.json. Quotes must be escaped. This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

exclusiveMaximum?​

optional exclusiveMaximum?: boolean | null

JSONSchema exclusiveMaximum

exclusiveMinimum?​

optional exclusiveMinimum?: boolean | null

JSONSchema exclusiveMinimum

extensions?​

optional extensions?: {[k: string]: $Properties; } | null

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

fieldConfiguration?​

optional fieldConfiguration?: $Properties | null

Additional field level properties used when generating the OpenAPI v2 file.

format?​

optional format?: string | null

Format

maximum?​

optional maximum?: number | null

Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,

maxItems?​

optional maxItems?: Long | null

JSONSchema maxItems

maxLength?​

optional maxLength?: Long | null

JSONSchema maxLength

maxProperties?​

optional maxProperties?: Long | null

JSONSchema maxProperties

minimum?​

optional minimum?: number | null

minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,

minItems?​

optional minItems?: Long | null

JSONSchema minItems

minLength?​

optional minLength?: Long | null

JSONSchema minLength

minProperties?​

optional minProperties?: Long | null

JSONSchema minProperties

multipleOf?​

optional multipleOf?: number | null

JSONSchema multipleOf

pattern?​

optional pattern?: string | null

JSONSchema pattern

readOnly?​

optional readOnly?: boolean | null

JSONSchema readOnly

ref?​

optional ref?: string | null

Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference, and that type must be imported into the protofile. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp".

required?​

optional required?: string[] | null

JSONSchema required

title?​

optional title?: string | null

The title of the schema.

type?​

optional type?: JSONSchemaSimpleTypes[] | null

JSONSchema type

uniqueItems?​

optional uniqueItems?: boolean | null

JSONSchema uniqueItems