Interface: IJSONSchema

protoc_gen_openapiv2.options.IJSONSchema

Properties of a JSONSchema.

Implemented by

• JSONSchema

Properties

array

• Optional array: null | string[]

Items in 'array' must be unique.

---

default

• Optional default: null | string

JSONSchema default

---

description

• Optional description: null | string

A short description of the schema.

---

enum

• Optional enum: null | string[]

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

---

example

• Optional example: null | string

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

JSONSchema exclusiveMaximum

---

exclusiveMinimum

• Optional exclusiveMinimum: null | boolean

JSONSchema exclusiveMinimum

---

extensions

• Optional extensions: null | { [k: string]: IValue; }

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: null | IFieldConfiguration

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

---

format

• Optional format: null | string

Format

---

maxItems

• Optional maxItems: null | Long

JSONSchema maxItems

---

maxLength

• Optional maxLength: null | Long

JSONSchema maxLength

---

maxProperties

• Optional maxProperties: null | Long

JSONSchema maxProperties

---

maximum

• Optional maximum: null | number

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

---

minItems

• Optional minItems: null | Long

JSONSchema minItems

---

minLength

• Optional minLength: null | Long

JSONSchema minLength

---

minProperties

• Optional minProperties: null | Long

JSONSchema minProperties

---

minimum

• Optional minimum: null | number

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

---

multipleOf

• Optional multipleOf: null | number

JSONSchema multipleOf

---

pattern

• Optional pattern: null | string

JSONSchema pattern

---

readOnly

• Optional readOnly: null | boolean

JSONSchema 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 | string[]

JSONSchema required

---

title

• Optional title: null | string

The title of the schema.

---

type

• Optional type: null | JSONSchemaSimpleTypes[]

JSONSchema type

---

uniqueItems

• Optional uniqueItems: null | boolean

JSONSchema uniqueItems