Skip to main content

Interface: $Properties

Properties of an EnumSchema.

Extended by​

Properties​

default?​

optional default?: string | null

EnumSchema default

description?​

optional description?: string | null

A short description of the schema.

example?​

optional example?: string | null

EnumSchema example

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/

externalDocs?​

optional externalDocs?: $Properties | null

Additional external documentation for this schema.

readOnly?​

optional readOnly?: boolean | null

EnumSchema 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?: boolean | null

EnumSchema required

title?​

optional title?: string | null

The title of the schema.