Interface: $Properties
options.EnumSchema.$Properties
Properties of an EnumSchema.
Hierarchy
-
$Properties
Properties
default
• Optional default: null | string
EnumSchema default
description
• Optional description: null | string
A short description of the schema.
example
• Optional example: null | string
EnumSchema example
extensions
• Optional extensions: null | { [k: string]: $Properties; }
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: null | $Properties
Additional external documentation for this schema.
readOnly
• Optional readOnly: null | boolean
EnumSchema readOnly
ref
• Optional ref: null | string
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: null | boolean
EnumSchema required
title
• Optional title: null | string
The title of the schema.